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
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
application/fhir+json
, json
application/fhir+json
, application/json-patch+json
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.
server
history-system
interaction.The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | C | D | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|---|
Patient | http://hl7.org/fhir/StructureDefinition/Patient | y | y | y | y | y | birthdate, name, family, _id, organization, active, email, general-practitioner, given, identifier, telecom | Patient: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 | |
Condition | http://hl7.org/fhir/StructureDefinition/Condition | y | y | y | _security, patient, long-term-condition, _id, onset-date, clinical-status | Condition:patient , * | ||||
MedicationRequest | http://hl7.org/fhir/StructureDefinition/MedicationRequest | y | y | y | y | _security, authoredon, status, nzeps-long-term-medication, patient, subject, _id | MedicationRequest:patient , MedicationRequest:subject , * | |||
Observation | http://hl7.org/fhir/StructureDefinition/Observation | y | y | _security, patient, subject, _id, date | Observation:patient , Observation:subject , * | |||||
Immunization | http://hl7.org/fhir/StructureDefinition/Immunization | y | y | date, patient, _id | Immunization:patient , * | |||||
AllergyIntolerance | http://hl7.org/fhir/StructureDefinition/AllergyIntolerance | y | y | clinical-status, date, patient, _id | AllergyIntolerance:patient , * | |||||
DiagnosticReport | http://hl7.org/fhir/StructureDefinition/DiagnosticReport | y | y | issued, _security, performer, patient, _id | DiagnosticReport:performer , DiagnosticReport:patient , * | |||||
Appointment | http://hl7.org/fhir/StructureDefinition/Appointment | y | y | y | y | practitioner, date, status, patient, slot, _id | Appointment:practitioner , Appointment:patient , Appointment:slot , * | |||
Slot | http://hl7.org/fhir/StructureDefinition/Slot | y | y | start, schedule, status, _id | Slot:schedule , * | Appointment:slot | ||||
Location | http://hl7.org/fhir/StructureDefinition/Location | y | y | identifier, name, endpoint, _id | Location:endpoint , * | Observation:subject | ||||
Practitioner | http://hl7.org/fhir/StructureDefinition/Practitioner | y | y | identifier, name, _id | Patient:general-practitioner , DiagnosticReport:performer , Appointment:practitioner , Task:owner | |||||
DocumentReference | http://hl7.org/fhir/StructureDefinition/DocumentReference | y | y | y | y | period, _security, patient, _id, type, date | DocumentReference:patient , * | |||
Binary | http://hl7.org/fhir/StructureDefinition/Binary | y | ||||||||
Media | http://hl7.org/fhir/StructureDefinition/Media | y | ||||||||
Communication | http://hl7.org/fhir/StructureDefinition/Communication | y | y | y | category, patient, _id | Communication:patient , * | ||||
Bundle | http://hl7.org/fhir/StructureDefinition/Bundle | y | y | y | identifier, composition, _lastUpdated, _profile, type, _security, _source, message, timestamp, _id, _tag | Bundle:composition , Bundle:message , * | ||||
Invoice | http://hl7.org/fhir/StructureDefinition/Invoice | y | y | y | _id | |||||
Account | http://hl7.org/fhir/StructureDefinition/Account | y | y | patient, _id | Account:patient , * | |||||
ChargeItem | http://hl7.org/fhir/StructureDefinition/ChargeItem | y | y | performing-organization, _id | ChargeItem:performing-organization , * | |||||
Task | http://hl7.org/fhir/StructureDefinition/Task | y | y | y | owner, patient, _id | Task:owner , Task:patient , * | ||||
ExplanationOfBenefit | http://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit | y | y | patient, _id | ExplanationOfBenefit:patient , * | |||||
Organization | http://hl7.org/fhir/StructureDefinition/Organization | Patient:organization , Patient:general-practitioner , DiagnosticReport:performer , ChargeItem:performing-organization , Task:owner | ||||||||
PractitionerRole | http://hl7.org/fhir/StructureDefinition/PractitionerRole | Patient:general-practitioner , DiagnosticReport:performer , Task:owner | ||||||||
Group | http://hl7.org/fhir/StructureDefinition/Group | Condition:patient , MedicationRequest:patient , MedicationRequest:subject , Observation:patient , Observation:subject , Immunization:patient , AllergyIntolerance:patient , DiagnosticReport:patient , DocumentReference:patient | ||||||||
Device | http://hl7.org/fhir/StructureDefinition/Device | Observation:subject , Task:owner | ||||||||
CareTeam | http://hl7.org/fhir/StructureDefinition/CareTeam | DiagnosticReport:performer , Task:owner | ||||||||
Schedule | http://hl7.org/fhir/StructureDefinition/Schedule | Slot:schedule | ||||||||
Endpoint | http://hl7.org/fhir/StructureDefinition/Endpoint | Location:endpoint | ||||||||
Composition | http://hl7.org/fhir/StructureDefinition/Composition | Bundle:composition | ||||||||
MessageHeader | http://hl7.org/fhir/StructureDefinition/MessageHeader | Bundle:message | ||||||||
HealthcareService | http://hl7.org/fhir/StructureDefinition/HealthcareService | Task:owner | ||||||||
RelatedPerson | http://hl7.org/fhir/StructureDefinition/RelatedPerson | Task:owner |
create
, read
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | birthdate | date | |
SHALL | name | string | 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 | family | string | Multiple Resources:
|
SHALL | _id | token | Logical id of this artifact |
SHALL | organization | reference | The organization that is the custodian of the patient record |
SHALL | active | token | Whether the patient record is active |
SHALL | token | Multiple Resources:
| |
SHALL | general-practitioner | reference | Patient's nominated general practitioner, not the organization that manages the record |
SHALL | given | string | Multiple Resources:
|
SHALL | identifier | token | A patient identifier |
SHALL | telecom | token | Multiple Resources:
|
create
, read
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _security | token | Security Labels applied to this resource |
SHALL | patient | reference | Multiple Resources:
|
SHALL | long-term-condition | token | Allows the client to retrieve only the Conditions marked as 'long term' |
SHALL | _id | token | Logical id of this artifact |
SHALL | onset-date | date | Date related onsets (dateTime and Period) |
SHALL | clinical-status | token | The clinical status of the condition |
create
, read
, update
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _security | token | Security Labels applied to this resource |
SHALL | authoredon | date | Return prescriptions written on this date |
SHALL | status | token | Multiple Resources:
|
SHALL | nzeps-long-term-medication | token | NZePS Long Term Medication Indicator |
SHALL | patient | reference | Multiple Resources:
|
SHALL | subject | reference | The identity of a patient to list orders for |
SHALL | _id | token | Logical id of this artifact |
read
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _security | token | Security Labels applied to this resource |
SHALL | patient | reference | Multiple Resources:
|
SHALL | subject | reference | The subject that the observation is about |
SHALL | _id | token | Logical id of this artifact |
SHALL | date | date | Multiple Resources:
|
read
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | date | date | Multiple Resources:
|
SHALL | patient | reference | Multiple Resources:
|
SHALL | _id | token | Logical id of this artifact |
read
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | clinical-status | token | active | inactive | resolved |
SHALL | date | date | Multiple Resources:
|
SHALL | patient | reference | Multiple Resources:
|
SHALL | _id | token | Logical id of this artifact |
read
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | issued | date | When the report was issued |
SHALL | _security | token | Security Labels applied to this resource |
SHALL | performer | reference | Who is responsible for the report |
SHALL | patient | reference | Multiple Resources:
|
SHALL | _id | token | Logical id of this artifact |
create
, read
, update
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | practitioner | reference | One of the individuals of the appointment is this practitioner |
SHALL | date | date | Appointment date/time. |
SHALL | status | token | The overall status of the appointment |
SHALL | patient | reference | One of the individuals of the appointment is this patient |
SHALL | slot | reference | The slots that this appointment is filling |
SHALL | _id | token | Logical id of this artifact |
read
, search-type
.read
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | An identifier for the location |
SHALL | name | string | A portion of the location's name or alias |
SHALL | endpoint | reference | Technical endpoints providing access to services operated for the location |
SHALL | _id | token | Logical id of this artifact |
read
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | A practitioner's Identifier |
SHALL | name | string | 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 | _id | token | Logical id of this artifact |
create
, read
, update
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | period | date | Time of service that is being documented |
SHALL | _security | token | Security Labels applied to this resource |
SHALL | patient | reference | Multiple Resources:
|
SHALL | _id | token | Logical id of this artifact |
SHALL | type | token | Multiple Resources:
|
SHALL | date | date | When this document reference was created |
read
.create
.create
, read
, search-type
.create
, read
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | Persistent identifier for the bundle |
SHALL | composition | reference | 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 | _lastUpdated | date | When the resource version last changed |
SHALL | _profile | uri | Profiles this resource claims to conform to |
SHALL | type | token | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection |
SHALL | _security | token | Security Labels applied to this resource |
SHALL | _source | uri | Identifies where the resource comes from |
SHALL | message | reference | 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 |
SHALL | timestamp | date | When the bundle was assembled |
SHALL | _id | token | Logical id of this artifact |
SHALL | _tag | token | Tags applied to this resource |
create
, read
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | Logical id of this artifact |
read
, search-type
.read
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | performing-organization | reference | Organization providing the charged service |
SHALL | _id | token | Logical id of this artifact |
create
, read
, search-type
.read
, search-type
.