Medtech ALEX v2.x Capability Statement - Medtech ALEX® Implementation Guide v0.0.1

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 v2.x Capability Statement

Official URL: https://alexapi.medtechglobal.com/fhir/v2/metadata				Version: 0.0.1
Active as of 2024-01-30				Computable Name: Medtech ALEX v2 Capability Statement

Represents the API exposed by Medtech ALEX v2.x

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement alexV2-x

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: 2024-01-30 05:33:38+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 Type	Profile	R	S	C	Searches	`_include`	`_revinclude`
Patient	http://hl7.org/fhir/StructureDefinition/Patient	y	y		active, organization, birthdate, name, _id, identifier, email, telecom, general-practitioner, given, family	`Patient:organization`, `Patient:general-practitioner`, `*`	`Condition:patient`, `MedicationRequest:subject`, `MedicationRequest:patient`, `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		clinical-status, long-term-condition, _security, _id, patient, onset-date	`Condition:patient`, `*`
MedicationRequest	http://hl7.org/fhir/StructureDefinition/MedicationRequest	y	y		_security, _id, authoredon, subject, patient, nzeps-long-term-medication, status	`MedicationRequest:subject`, `MedicationRequest:patient`, `*`
AllergyIntolerance	http://hl7.org/fhir/StructureDefinition/AllergyIntolerance	y	y		_id, date, patient, clinical-status	`AllergyIntolerance:patient`, `*`
DiagnosticReport	https://fhir.medtechglobal.com/StructureDefinition/pathology-bundle	y	y		issued, _security, _id, performer, patient	`DiagnosticReport:performer`, `DiagnosticReport:patient`, `*`
Location	http://hl7.org/fhir/StructureDefinition/Location	y	y		endpoint, name, identifier, _id	`Location:endpoint`, `*`	`Observation:subject`
Practitioner	http://hl7.org/fhir/StructureDefinition/Practitioner	y	y		active, name, identifier, _id		`Patient:general-practitioner`, `DiagnosticReport:performer`, `Appointment:practitioner`, `Task:owner`
DocumentReference	http://hl7.org/fhir/StructureDefinition/DocumentReference	y	y		date, type, _security, _id, patient, period	`DocumentReference:patient`, `*`
Bundle	http://hl7.org/fhir/StructureDefinition/Bundle	y	y	y	message, _tag, _security, _lastUpdated, identifier, _id, composition, _source, type, timestamp, _profile	`Bundle:message`, `Bundle:composition`, `*`
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`
MessageHeader	http://hl7.org/fhir/StructureDefinition/MessageHeader						`Bundle:message`
Composition	http://hl7.org/fhir/StructureDefinition/Composition						`Bundle:composition`
HealthcareService	http://hl7.org/fhir/StructureDefinition/HealthcareService						`Task:owner`
RelatedPerson	http://hl7.org/fhir/StructureDefinition/RelatedPerson						`Task:owner`

Resource Conformance: supported Patient

Base System Profile
http://hl7.org/fhir/StructureDefinition/Patient

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

The Patient resource represents patient demographics.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	active	`token`	Whether the patient record is active
SHALL	organization	`reference`	The organization that is the custodian of the patient record
SHALL	birthdate	`date`	Multiple Resources: Patient: The patient's date of birth Person: The person's date of birth RelatedPerson: The Related Person's date of birth
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
SHALL	identifier	`token`	A patient identifier
SHALL	email	`token`	Multiple Resources: Patient: A value in an email contact Person: A value in an email contact Practitioner: A value in an email contact PractitionerRole: A value in an email contact RelatedPerson: A value in an email contact
SHALL	telecom	`token`	Multiple Resources: Patient: The value in any kind of telecom details of the patient Person: The value in any kind of contact Practitioner: The value in any kind of contact PractitionerRole: The value in any kind of contact RelatedPerson: The value in any kind of contact
SHALL	general-practitioner	`reference`	Patient's nominated general practitioner, not the organization that manages the record
SHALL	given	`string`	Multiple Resources: Patient: A portion of the given name of the patient Practitioner: A portion of the given name
SHALL	family	`string`	Multiple Resources: Patient: A portion of the family name of the patient Practitioner: A portion of the family name

Resource Conformance: supported Condition

Base System Profile
http://hl7.org/fhir/StructureDefinition/Condition

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	clinical-status	`token`	The clinical status of the condition
SHALL	long-term-condition	`token`	Allows the client to retrieve only the Conditions marked as 'long term'
SHALL	_security	`token`	Security Labels applied to this resource
SHALL	_id	`token`	Logical id of this artifact
SHALL	patient	`reference`	Multiple Resources: AllergyIntolerance: Who the sensitivity is for CarePlan: Who the care plan is for CareTeam: Who care team is for ClinicalImpression: Patient or group assessed Composition: Who and/or what the composition is about Condition: Who has the condition? Consent: Who the consent applies to DetectedIssue: Associated patient DeviceRequest: Individual the service is ordered for DeviceUseStatement: Search by subject - a patient DiagnosticReport: The subject of the report if a patient DocumentManifest: The subject of the set of documents DocumentReference: Who/what is the subject of the document Encounter: The patient or group present at the encounter EpisodeOfCare: The patient who is the focus of this episode of care FamilyMemberHistory: The identity of a subject to list family member history items for Flag: The identity of a subject to list flags for Goal: Who this goal is intended for ImagingStudy: Who the study is about Immunization: The patient for the vaccination record List: If all resources have the same subject MedicationAdministration: The identity of a patient to list administrations for MedicationDispense: The identity of a patient to list dispenses for MedicationRequest: Returns prescriptions for a specific patient MedicationStatement: Returns statements for a specific patient. NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement Observation: The subject that the observation is about (if patient) Procedure: Search by subject - a patient RiskAssessment: Who/what does assessment apply to? ServiceRequest: Search by subject - a patient SupplyDelivery: Patient for whom the item is supplied VisionPrescription: The identity of a patient to list dispenses for
SHALL	onset-date	`date`	Date related onsets (dateTime and Period)

Resource Conformance: supported MedicationRequest

Base System Profile
http://hl7.org/fhir/StructureDefinition/MedicationRequest

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_security	`token`	Security Labels applied to this resource
SHALL	_id	`token`	Logical id of this artifact
SHALL	authoredon	`date`	Return prescriptions written on this date
SHALL	subject	`reference`	The identity of a patient to list orders for
SHALL	patient	`reference`	Multiple Resources: AllergyIntolerance: Who the sensitivity is for CarePlan: Who the care plan is for CareTeam: Who care team is for ClinicalImpression: Patient or group assessed Composition: Who and/or what the composition is about Condition: Who has the condition? Consent: Who the consent applies to DetectedIssue: Associated patient DeviceRequest: Individual the service is ordered for DeviceUseStatement: Search by subject - a patient DiagnosticReport: The subject of the report if a patient DocumentManifest: The subject of the set of documents DocumentReference: Who/what is the subject of the document Encounter: The patient or group present at the encounter EpisodeOfCare: The patient who is the focus of this episode of care FamilyMemberHistory: The identity of a subject to list family member history items for Flag: The identity of a subject to list flags for Goal: Who this goal is intended for ImagingStudy: Who the study is about Immunization: The patient for the vaccination record List: If all resources have the same subject MedicationAdministration: The identity of a patient to list administrations for MedicationDispense: The identity of a patient to list dispenses for MedicationRequest: Returns prescriptions for a specific patient MedicationStatement: Returns statements for a specific patient. NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement Observation: The subject that the observation is about (if patient) Procedure: Search by subject - a patient RiskAssessment: Who/what does assessment apply to? ServiceRequest: Search by subject - a patient SupplyDelivery: Patient for whom the item is supplied VisionPrescription: The identity of a patient to list dispenses for
SHALL	nzeps-long-term-medication	`token`	NZePS Long Term Medication Indicator
SHALL	status	`token`	Multiple Resources: MedicationAdministration: MedicationAdministration event status (for example one of active/paused/completed/nullified) MedicationDispense: Returns dispenses with a specified dispense status MedicationRequest: Status of the prescription MedicationStatement: Return statements that match the given status

Resource Conformance: supported AllergyIntolerance

Base System Profile
http://hl7.org/fhir/StructureDefinition/AllergyIntolerance

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	Logical id of this artifact
SHALL	date	`date`	Multiple Resources: AllergyIntolerance: Date first version of the resource instance was recorded CarePlan: Time period plan covers CareTeam: Time period team covers ClinicalImpression: When the assessment was documented Composition: Composition editing time Consent: When this Consent was created or indexed DiagnosticReport: The clinically relevant time of the report Encounter: A date within the period the Encounter lasted EpisodeOfCare: The provided date search value falls within the episode of care's period FamilyMemberHistory: When history was recorded or last updated Flag: Time period when flag is active Immunization: Vaccination (non)-Administration Date List: When the list was prepared Observation: Obtained date/time. If the obtained element is a period, a date that falls in the period Procedure: When the procedure was performed RiskAssessment: When was assessment made? SupplyRequest: When the request was made
SHALL	patient	`reference`	Multiple Resources: AllergyIntolerance: Who the sensitivity is for CarePlan: Who the care plan is for CareTeam: Who care team is for ClinicalImpression: Patient or group assessed Composition: Who and/or what the composition is about Condition: Who has the condition? Consent: Who the consent applies to DetectedIssue: Associated patient DeviceRequest: Individual the service is ordered for DeviceUseStatement: Search by subject - a patient DiagnosticReport: The subject of the report if a patient DocumentManifest: The subject of the set of documents DocumentReference: Who/what is the subject of the document Encounter: The patient or group present at the encounter EpisodeOfCare: The patient who is the focus of this episode of care FamilyMemberHistory: The identity of a subject to list family member history items for Flag: The identity of a subject to list flags for Goal: Who this goal is intended for ImagingStudy: Who the study is about Immunization: The patient for the vaccination record List: If all resources have the same subject MedicationAdministration: The identity of a patient to list administrations for MedicationDispense: The identity of a patient to list dispenses for MedicationRequest: Returns prescriptions for a specific patient MedicationStatement: Returns statements for a specific patient. NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement Observation: The subject that the observation is about (if patient) Procedure: Search by subject - a patient RiskAssessment: Who/what does assessment apply to? ServiceRequest: Search by subject - a patient SupplyDelivery: Patient for whom the item is supplied VisionPrescription: The identity of a patient to list dispenses for
SHALL	clinical-status	`token`	active \| inactive \| resolved

Resource Conformance: supported DiagnosticReport

Base System Profile
https://fhir.medtechglobal.com/StructureDefinition/pathology-bundle

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	issued	`date`	When the report was issued
SHALL	_security	`token`	Security Labels applied to this resource
SHALL	_id	`token`	Logical id of this artifact
SHALL	performer	`reference`	Who is responsible for the report
SHALL	patient	`reference`	Multiple Resources: AllergyIntolerance: Who the sensitivity is for CarePlan: Who the care plan is for CareTeam: Who care team is for ClinicalImpression: Patient or group assessed Composition: Who and/or what the composition is about Condition: Who has the condition? Consent: Who the consent applies to DetectedIssue: Associated patient DeviceRequest: Individual the service is ordered for DeviceUseStatement: Search by subject - a patient DiagnosticReport: The subject of the report if a patient DocumentManifest: The subject of the set of documents DocumentReference: Who/what is the subject of the document Encounter: The patient or group present at the encounter EpisodeOfCare: The patient who is the focus of this episode of care FamilyMemberHistory: The identity of a subject to list family member history items for Flag: The identity of a subject to list flags for Goal: Who this goal is intended for ImagingStudy: Who the study is about Immunization: The patient for the vaccination record List: If all resources have the same subject MedicationAdministration: The identity of a patient to list administrations for MedicationDispense: The identity of a patient to list dispenses for MedicationRequest: Returns prescriptions for a specific patient MedicationStatement: Returns statements for a specific patient. NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement Observation: The subject that the observation is about (if patient) Procedure: Search by subject - a patient RiskAssessment: Who/what does assessment apply to? ServiceRequest: Search by subject - a patient SupplyDelivery: Patient for whom the item is supplied VisionPrescription: The identity of a patient to list dispenses for

Resource Conformance: supported Location

Base System Profile
http://hl7.org/fhir/StructureDefinition/Location

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	endpoint	`reference`	Technical endpoints providing access to services operated for the location
SHALL	name	`string`	A portion of the location's name or alias
SHALL	identifier	`token`	An identifier for the location
SHALL	_id	`token`	Logical id of this artifact

Resource Conformance: supported Practitioner

Base System Profile
http://hl7.org/fhir/StructureDefinition/Practitioner

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	active	`token`	Whether the practitioner record is active
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	identifier	`token`	A practitioner's Identifier
SHALL	_id	`token`	Logical id of this artifact

Resource Conformance: supported DocumentReference

Base System Profile
http://hl7.org/fhir/StructureDefinition/DocumentReference

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	date	`date`	When this document reference was created
SHALL	type	`token`	Multiple Resources: AllergyIntolerance: allergy \| intolerance - Underlying mechanism (if known) Composition: Kind of composition (LOINC if possible) DocumentManifest: Kind of document set DocumentReference: Kind of document (LOINC if possible) Encounter: Specific type of encounter EpisodeOfCare: Type/class - e.g. specialist referral, disease management
SHALL	_security	`token`	Security Labels applied to this resource
SHALL	_id	`token`	Logical id of this artifact
SHALL	patient	`reference`	Multiple Resources: AllergyIntolerance: Who the sensitivity is for CarePlan: Who the care plan is for CareTeam: Who care team is for ClinicalImpression: Patient or group assessed Composition: Who and/or what the composition is about Condition: Who has the condition? Consent: Who the consent applies to DetectedIssue: Associated patient DeviceRequest: Individual the service is ordered for DeviceUseStatement: Search by subject - a patient DiagnosticReport: The subject of the report if a patient DocumentManifest: The subject of the set of documents DocumentReference: Who/what is the subject of the document Encounter: The patient or group present at the encounter EpisodeOfCare: The patient who is the focus of this episode of care FamilyMemberHistory: The identity of a subject to list family member history items for Flag: The identity of a subject to list flags for Goal: Who this goal is intended for ImagingStudy: Who the study is about Immunization: The patient for the vaccination record List: If all resources have the same subject MedicationAdministration: The identity of a patient to list administrations for MedicationDispense: The identity of a patient to list dispenses for MedicationRequest: Returns prescriptions for a specific patient MedicationStatement: Returns statements for a specific patient. NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement Observation: The subject that the observation is about (if patient) Procedure: Search by subject - a patient RiskAssessment: Who/what does assessment apply to? ServiceRequest: Search by subject - a patient SupplyDelivery: Patient for whom the item is supplied VisionPrescription: The identity of a patient to list dispenses for
SHALL	period	`date`	Time of service that is being documented

Resource Conformance: supported Bundle

Base System Profile
http://hl7.org/fhir/StructureDefinition/Bundle

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports create, read, search-type.

Search Parameters

Conformance	Parameter	Type	Documentation
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	_tag	`token`	Tags applied to this resource
SHALL	_security	`token`	Security Labels applied to this resource
SHALL	_lastUpdated	`date`	When the resource version last changed
SHALL	identifier	`token`	Persistent identifier for the bundle
SHALL	_id	`token`	Logical id of this artifact
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	_source	`uri`	Identifies where the resource comes from
SHALL	type	`token`	document \| message \| transaction \| transaction-response \| batch \| batch-response \| history \| searchset \| collection
SHALL	timestamp	`date`	When the bundle was assembled
SHALL	_profile	`uri`	Profiles this resource claims to conform to

Resource Conformance: supported Device

Base System Profile
http://hl7.org/fhir/StructureDefinition/Device

Profile Conformance
SHALL

Reference Policy

Interaction summary

Resource Conformance: supported CareTeam

Base System Profile
http://hl7.org/fhir/StructureDefinition/CareTeam

Profile Conformance
SHALL

Reference Policy

Interaction summary

Resource Conformance: supported Schedule

Base System Profile
http://hl7.org/fhir/StructureDefinition/Schedule

Profile Conformance
SHALL

Reference Policy

Interaction summary

Resource Conformance: supported Endpoint

Base System Profile
http://hl7.org/fhir/StructureDefinition/Endpoint

Profile Conformance
SHALL

Reference Policy

Interaction summary

Resource Conformance: supported MessageHeader

Base System Profile
http://hl7.org/fhir/StructureDefinition/MessageHeader

Profile Conformance
SHALL

Reference Policy

Interaction summary

Resource Conformance: supported Composition

Base System Profile
http://hl7.org/fhir/StructureDefinition/Composition

Profile Conformance
SHALL

Reference Policy

Interaction summary

Resource Conformance: supported HealthcareService

Base System Profile
http://hl7.org/fhir/StructureDefinition/HealthcareService

Profile Conformance
SHALL

Reference Policy

Interaction summary

Resource Conformance: supported RelatedPerson

Base System Profile
http://hl7.org/fhir/StructureDefinition/RelatedPerson

Profile Conformance
SHALL

Reference Policy

Interaction summary

CapabilityStatement: Medtech ALEX v2.x Capability Statement

Capability Statement describing Medtech ALEX FHIR APIs

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: supported Patient

Resource Conformance: supported Condition

Resource Conformance: supported MedicationRequest

Resource Conformance: supported AllergyIntolerance

Resource Conformance: supported DiagnosticReport

Resource Conformance: supported Location

Resource Conformance: supported Practitioner

Resource Conformance: supported DocumentReference

Resource Conformance: supported Bundle

Resource Conformance: supported Device

Resource Conformance: supported CareTeam

Resource Conformance: supported Schedule

Resource Conformance: supported Endpoint

Resource Conformance: supported MessageHeader

Resource Conformance: supported Composition

Resource Conformance: supported HealthcareService

Resource Conformance: supported RelatedPerson

Mode: `server`