Medtech ALEX® Implementation Guide
0.0.1 - draft International flag

Medtech ALEX® Implementation Guide - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: Medtech ALEX v1.2x Capability Statement

Official URL: https://alexapi.medtechglobal.com/fhir/metadata Version: 0.0.1
Active as of 2023-11-13 Computable Name: Medtech ALEX v1 Capability Statement

Represents the API exposed by Medtech ALEX v1.2x

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement alexV1-2x

Capability Statement describing Medtech ALEX FHIR APIs

  • Implementation Guide Version: 0.0.1
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+json, json
  • Supported Patch Formats: application/fhir+json, application/json-patch+json
  • Published on: 2023-11-13 02:58:40+0000
  • Published by: Medtech Global

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions
  • Supports the history-systeminteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCDSearches_include_revincludeOperations
Patienthttp://hl7.org/fhir/StructureDefinition/Patientyyyyybirthdate, name, family, _id, organization, active, email, general-practitioner, given, identifier, telecomPatient:organization, Patient:general-practitioner, *Condition:patient, MedicationRequest:patient, MedicationRequest:subject, Observation:patient, Observation:subject, Immunization:patient, AllergyIntolerance:patient, DiagnosticReport:patient, Appointment:patient, DocumentReference:patient, Communication:patient, Account:patient, Task:owner, Task:patient, ExplanationOfBenefit:patient
Conditionhttp://hl7.org/fhir/StructureDefinition/Conditionyyy_security, patient, long-term-condition, _id, onset-date, clinical-statusCondition:patient, *
MedicationRequesthttp://hl7.org/fhir/StructureDefinition/MedicationRequestyyyy_security, authoredon, status, nzeps-long-term-medication, patient, subject, _idMedicationRequest:patient, MedicationRequest:subject, *
Observationhttp://hl7.org/fhir/StructureDefinition/Observationyy_security, patient, subject, _id, dateObservation:patient, Observation:subject, *
Immunizationhttp://hl7.org/fhir/StructureDefinition/Immunizationyydate, patient, _idImmunization:patient, *
AllergyIntolerancehttp://hl7.org/fhir/StructureDefinition/AllergyIntoleranceyyclinical-status, date, patient, _idAllergyIntolerance:patient, *
DiagnosticReporthttp://hl7.org/fhir/StructureDefinition/DiagnosticReportyyissued, _security, performer, patient, _idDiagnosticReport:performer, DiagnosticReport:patient, *
Appointmenthttp://hl7.org/fhir/StructureDefinition/Appointmentyyyypractitioner, date, status, patient, slot, _idAppointment:practitioner, Appointment:patient, Appointment:slot, *
Slothttp://hl7.org/fhir/StructureDefinition/Slotyystart, schedule, status, _idSlot:schedule, *Appointment:slot
Locationhttp://hl7.org/fhir/StructureDefinition/Locationyyidentifier, name, endpoint, _idLocation:endpoint, *Observation:subject
Practitionerhttp://hl7.org/fhir/StructureDefinition/Practitioneryyidentifier, name, _idPatient:general-practitioner, DiagnosticReport:performer, Appointment:practitioner, Task:owner
DocumentReferencehttp://hl7.org/fhir/StructureDefinition/DocumentReferenceyyyyperiod, _security, patient, _id, type, dateDocumentReference:patient, *
Binaryhttp://hl7.org/fhir/StructureDefinition/Binaryy
Mediahttp://hl7.org/fhir/StructureDefinition/Mediay
Communicationhttp://hl7.org/fhir/StructureDefinition/Communicationyyycategory, patient, _idCommunication:patient, *
Bundlehttp://hl7.org/fhir/StructureDefinition/Bundleyyyidentifier, composition, _lastUpdated, _profile, type, _security, _source, message, timestamp, _id, _tagBundle:composition, Bundle:message, *
Invoicehttp://hl7.org/fhir/StructureDefinition/Invoiceyyy_id
Accounthttp://hl7.org/fhir/StructureDefinition/Accountyypatient, _idAccount:patient, *
ChargeItemhttp://hl7.org/fhir/StructureDefinition/ChargeItemyyperforming-organization, _idChargeItem:performing-organization, *
Taskhttp://hl7.org/fhir/StructureDefinition/Taskyyyowner, patient, _idTask:owner, Task:patient, *
ExplanationOfBenefithttp://hl7.org/fhir/StructureDefinition/ExplanationOfBenefityypatient, _idExplanationOfBenefit:patient, *
Organizationhttp://hl7.org/fhir/StructureDefinition/OrganizationPatient:organization, Patient:general-practitioner, DiagnosticReport:performer, ChargeItem:performing-organization, Task:owner
PractitionerRolehttp://hl7.org/fhir/StructureDefinition/PractitionerRolePatient:general-practitioner, DiagnosticReport:performer, Task:owner
Grouphttp://hl7.org/fhir/StructureDefinition/GroupCondition:patient, MedicationRequest:patient, MedicationRequest:subject, Observation:patient, Observation:subject, Immunization:patient, AllergyIntolerance:patient, DiagnosticReport:patient, DocumentReference:patient
Devicehttp://hl7.org/fhir/StructureDefinition/DeviceObservation:subject, Task:owner
CareTeamhttp://hl7.org/fhir/StructureDefinition/CareTeamDiagnosticReport:performer, Task:owner
Schedulehttp://hl7.org/fhir/StructureDefinition/ScheduleSlot:schedule
Endpointhttp://hl7.org/fhir/StructureDefinition/EndpointLocation:endpoint
Compositionhttp://hl7.org/fhir/StructureDefinition/CompositionBundle:composition
MessageHeaderhttp://hl7.org/fhir/StructureDefinition/MessageHeaderBundle:message
HealthcareServicehttp://hl7.org/fhir/StructureDefinition/HealthcareServiceTask:owner
RelatedPersonhttp://hl7.org/fhir/StructureDefinition/RelatedPersonTask:owner

Resource Conformance: supported Patient

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create, read, update, delete, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLbirthdatedate

Multiple Resources:

SHALLnamestring

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

SHALLfamilystring

Multiple Resources:

SHALL_idtoken

Logical id of this artifact

SHALLorganizationreference

The organization that is the custodian of the patient record

SHALLactivetoken

Whether the patient record is active

SHALLemailtoken

Multiple Resources:

SHALLgeneral-practitionerreference

Patient's nominated general practitioner, not the organization that manages the record

SHALLgivenstring

Multiple Resources:

SHALLidentifiertoken

A patient identifier

SHALLtelecomtoken

Multiple Resources:

 

Resource Conformance: supported Condition

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create, read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_securitytoken

Security Labels applied to this resource

SHALLpatientreference

Multiple Resources:

SHALLlong-term-conditiontoken

Allows the client to retrieve only the Conditions marked as 'long term'

SHALL_idtoken

Logical id of this artifact

SHALLonset-datedate

Date related onsets (dateTime and Period)

SHALLclinical-statustoken

The clinical status of the condition

 

Resource Conformance: supported MedicationRequest

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create, read, update, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_securitytoken

Security Labels applied to this resource

SHALLauthoredondate

Return prescriptions written on this date

SHALLstatustoken

Multiple Resources:

SHALLnzeps-long-term-medicationtoken

NZePS Long Term Medication Indicator

SHALLpatientreference

Multiple Resources:

SHALLsubjectreference

The identity of a patient to list orders for

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supported Observation

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_securitytoken

Security Labels applied to this resource

SHALLpatientreference

Multiple Resources:

SHALLsubjectreference

The subject that the observation is about

SHALL_idtoken

Logical id of this artifact

SHALLdatedate

Multiple Resources:

 

Resource Conformance: supported Immunization

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLdatedate

Multiple Resources:

SHALLpatientreference

Multiple Resources:

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supported AllergyIntolerance

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLclinical-statustoken

active | inactive | resolved

SHALLdatedate

Multiple Resources:

SHALLpatientreference

Multiple Resources:

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supported DiagnosticReport

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLissueddate

When the report was issued

SHALL_securitytoken

Security Labels applied to this resource

SHALLperformerreference

Who is responsible for the report

SHALLpatientreference

Multiple Resources:

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supported Appointment

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create, read, update, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpractitionerreference

One of the individuals of the appointment is this practitioner

SHALLdatedate

Appointment date/time.

SHALLstatustoken

The overall status of the appointment

SHALLpatientreference

One of the individuals of the appointment is this patient

SHALLslotreference

The slots that this appointment is filling

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supported Slot

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLstartdate

Appointment date/time.

SHALLschedulereference

The Schedule Resource that we are seeking a slot within

SHALLstatustoken

The free/busy status of the appointment

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supported Location

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

An identifier for the location

SHALLnamestring

A portion of the location's name or alias

SHALLendpointreference

Technical endpoints providing access to services operated for the location

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supported Practitioner

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

A practitioner's Identifier

SHALLnamestring

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supported DocumentReference

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create, read, update, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLperioddate

Time of service that is being documented

SHALL_securitytoken

Security Labels applied to this resource

SHALLpatientreference

Multiple Resources:

SHALL_idtoken

Logical id of this artifact

SHALLtypetoken

Multiple Resources:

SHALLdatedate

When this document reference was created

 

Resource Conformance: supported Binary

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Resource Conformance: supported Media

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create.

Resource Conformance: supported Communication

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create, read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcategorytoken

Message category

SHALLpatientreference

Focus of message

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supported Bundle

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create, read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Persistent identifier for the bundle

SHALLcompositionreference

The first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to search its contents

SHALL_lastUpdateddate

When the resource version last changed

SHALL_profileuri

Profiles this resource claims to conform to

SHALLtypetoken

document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection

SHALL_securitytoken

Security Labels applied to this resource

SHALL_sourceuri

Identifies where the resource comes from

SHALLmessagereference

The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents

SHALLtimestampdate

When the bundle was assembled

SHALL_idtoken

Logical id of this artifact

SHALL_tagtoken

Tags applied to this resource

 

Resource Conformance: supported Invoice

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create, read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supported Account

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The entity that caused the expenses

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supported ChargeItem

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLperforming-organizationreference

Organization providing the charged service

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supported Task

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create, read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLownerreference

Search by task owner

SHALLpatientreference

Search by patient

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supported ExplanationOfBenefit

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The reference to the patient

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supported Organization

Profile Conformance
SHALL
Reference Policy

Interaction summary

    Resource Conformance: supported PractitionerRole

    Profile Conformance
    SHALL
    Reference Policy

    Interaction summary

      Resource Conformance: supported Group

      Profile Conformance
      SHALL
      Reference Policy

      Interaction summary

        Resource Conformance: supported Device

        Profile Conformance
        SHALL
        Reference Policy

        Interaction summary

          Resource Conformance: supported CareTeam

          Profile Conformance
          SHALL
          Reference Policy

          Interaction summary

            Resource Conformance: supported Schedule

            Profile Conformance
            SHALL
            Reference Policy

            Interaction summary

              Resource Conformance: supported Endpoint

              Profile Conformance
              SHALL
              Reference Policy

              Interaction summary

                Resource Conformance: supported Composition

                Profile Conformance
                SHALL
                Reference Policy

                Interaction summary

                  Resource Conformance: supported MessageHeader

                  Profile Conformance
                  SHALL
                  Reference Policy

                  Interaction summary

                    Resource Conformance: supported HealthcareService

                    Profile Conformance
                    SHALL
                    Reference Policy

                    Interaction summary

                      Resource Conformance: supported RelatedPerson

                      Profile Conformance
                      SHALL
                      Reference Policy

                      Interaction summary