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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Allergy Intolerance Bundle

The Bundle response for Allergy Intolerance search using the ALEX platform

Allergy Intolerance IPS Profile

The allergy intolerance for IPS

Allergy Intolerance Profile

The allergy intolerance exposed by ALEX.

Bundle - IPS (AU)

This profile represents the constraints applied to the Bundle resource by the Medtech FHIR International Patient Summary (IPS)

Communication

The ALEX Communication

Communication Bundle

The Bundle response for Communication search using the ALEX platform

Composition IPS

The Composition resource exposed by the ALEX infrastructure for IPS

Condition Bundle

The Bundle response for Condition search using the ALEX platform

Condition IPS Profile

The Condition resource for IPS

Condition Profile

The Condition resource exposed by ALEX

Consultation Notes Bundle

The Bundle response for Consultation Notes search using the ALEX platform

Consultation Notes IPS Profile

The Consultation Notes for IPS

Consultation Notes Profile

The Consultation Notes exposed by ALEX

Device IPS profile

The Device resource exposed by the ALEX IPS

Diagnostic Report Bundle

The Bundle response for Diagnostic Report search using the ALEX platform

Diagnostic Report IPS Profile

The Diagnostic Report for IPS

Diagnostic Report Profile

The Diagnostic Report exposed by ALEX

Discharge Summary

The ALEX Discharge Summary that utilises the DocumentResource resource

Discharge Summary Bundle

The Bundle response for Discharge Summary search using the ALEX platform

Discharge Summary IPS Profile

The ALEX Discharge Summary for IPS that utilises the DocumentResource resource

Immunisation Bundle

The Bundle response for Immunisation search using the ALEX platform

Immunisation IPS Profile

The Immunisation for IPS

Immunisation Profile

The Immunisation exposed by ALEX

Location Bundle

The Bundle response for Location search using the ALEX platform

Location Profile

The Location resource exposed by ALEX.

Medication Request Bundle

The Bundle response for Medication Request search using the ALEX platform

Medication Request Profile

The Medication Request resource exposed by ALEX.

Medication Statement IPS Profile

The Medication Statement resource exposed by ALEX for IPS

NCTS Complete Code System

This StructureDefinition describes the NCTS Complete Code System, a profile of the FHIR® CodeSystem resource. The NCTS Complete Code System is designed to represent terminologies published as part of the National Clinical Terminology Service, and maximise interoperability within the NCTS ecosystem.

NCTS Composed Value Set

This StructureDefinition describes the NCTS Composed Value Set, a profile of the FHIR® ValueSet resource. The NCTS Composed Value Set is designed to represent value sets published as part of the National Clinical Terminology Service, and maximise interoperability within the NCTS ecosystem.

Observation Bundle

The Bundle response for Observation search using the ALEX platform

Observation IPS Profile

The observation for IPS

Observation Profile

The observation exposed by ALEX.

Outbox

The ALEX Outbox that utilises the Communication resource

Outbox Bundle

The Bundle response for Outbox search using the ALEX platform

Patient Bundle

The Bundle response for Patient search using the ALEX platform

Patient IPS Profile

The Patient resource for IPS

Patient Profile

The Patient resource exposed by ALEX

Practitioner Bundle

The Bundle response for Practitioner search using the ALEX platform

Practitioner IPS Profile

The Practitioner resource for IPS

Practitioner Profile

The Practitioner resource exposed by ALEX

PractitionerRole IPS profile

The PractitionerRole resource exposed by the ALEX infrastructure for IPS

Repeat Prescription Post Bundle

The Bundle payload for post of Repeat Prescription

Repeat Prescription Profile

The Repeat Prescription exposed by ALEX.

Structures: Data Type Profiles

These define constraints on FHIR data types for systems conforming to this implementation guide.

Address

The address that conforms to Medtech PMS address structure

HPI-I
HPI-O

This identifier profile defines a Healthcare Provider Identifier - Organisation in an Australian context (see Australian Digital Health Agency for further information). An HPI-O is assigned under the HI Service to an organisation (such as a hospital or medical clinic) where healthcare is provided.

Medicare Provider Number

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Account Held By extension

Patient Resource - Patient Account Held By Reference (Patient Register Screen)

Account Holder extension

Patient Resource - Patient Account Holder status (Patient Register Screen)

Allergy Intolerance Reaction Type Extension
Allergy Intolerance Type Extension
Associated Location
Comment extension

Comment

HPI-I Status
HPI-O Status

This extension applies to the Identifier data type and is used to represent the status of the associated organisation (HPI-O) and indicates whether the status of the HPI-O is active or otherwise.

Medication Approved Number extension

Medication Request/Statement Resource - Medication Approved Number

Medication Authority Number extension

Medication Request/Statement Resource - Medication Authority Number

Medication Long Term extension

Medication Request/Statement Resource - Long Term

Medication Regulation 24 extension

Medication Request/Statement Resource - Regulation 24

Medication Scheme extension

Medication Request/Statement Resource - Medication Scheme

Medication Unusual Dose extension

Medication Request/Statement Resource - Unusual Dose

Medtech Condition Location Bilateral extension

Condition Location - Bilateral

Medtech Condition Location Left extension

Condition Location - Left

Medtech Condition Location Right extension

Condition Location - Right

Medtech Current Condition extension

Condition Resource - Current status

Medtech Highlight Condition extension

Condition Resource - Highlight status

Medtech Long Term Condition extension

Condition Resource - Long Term status

PMS Version extension

Location Resource - The version of the PMS installed at the location

Patient Account Group extension

Patient Resource - Patient Account Group

Patient Location extension

Patient Resource - Patient Location by Reference

Patient Registration status extension

Patient Resource - Registration Status (Patient Register Screen)

Patient ethnicity extension

Patient Resource - Ethnicity

Practitioner Affiliation Extension

Practitioner Resource - Practitioner Affiliation

Sex at Birth extension

Patient Resource - Patient Sex at Birth

Vaccine Vial Serial Number

This extension applies to the Immunization resource and is used to represent the serial number of the vial of vaccine.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

ANZSIC ValueSet

Developed for use in the collection, analysis and dissemination of industry classification statistics in Australia and New Zealand.

Allergy Intolerance Code

Defines the code for Allergy Intolerance

Allergy Intolerance Manifestation Code Value Set

Defines the value set for the manifestation

Australian Indigenous Status

The Australian Indigenous Status value set includes values to support the representation of a person's Indigenous status. That is, whether a person identifies as being of Aboriginal or Torres Strait Islander origin. The values are those concepts defined in the Australian Indigenous Status code system (https://healthterminologies.gov.au/fhir/CodeSystem/australian-indigenous-status-1).

Australian Medication

The Australian Medication value set includes all Australian Medicines Terminology (AMT) product concepts that may be used for the identification of a medicine, vaccine or other therapeutic good. This is suitable for the recording of a product which may be ordered for, administered to, or used by an individual.

Australian States and Territories

The Australian States and Territories value set includes values that represent the Australian states and territories.

Codes for Immunization Site of Administration

Codes for Immunization Site of Administration

Condition Code Value Set

Defines the value set for the Condition identification

Consultation Note Content Format Value Set

Defines the format of the consultation note content

Contact Relationship Type

The Contact Relationship Type value set includes values that may be used to describe the nature of the relationship between the subject and the contact person.

Daily Frequency Value Set for Dosage

Defines the daily frequency for Dosage

Definition of Confidentiality Value Set

Defines the usage of confidentiality by ALEX resources

Diagnostic Category Value Set

Defines the diagnostic category supported by ALEX

Diagnostic Code Value Set

Defines the diagnostic codes

Doc Section Codes for Composition

Defines the section codes for Composition

Duration

Defines the duration

Immunisation Route of Administration

Defines the route codes for immunisation

Immunisation Vaccine Value Set

Defines the value set for immunisation vaccine

Individual Healthcare Identifier Record Status

The Individual Healthcare Identifier Record Status value set includes values that may be used to describe the classification status of a record of an Individual Healthcare Identifier.

Individual Healthcare Identifier Status

The Individual Healthcare Identifier Status value set includes values that may be used to describe the classification status of an Individual Healthcare Identifier.

Interpretation Value Set for Observation

Defines the interpretation for Observation

Medication Reason Taken

The Medication Reason Taken value set includes values that identify a reason why a medication has been or is being taken.

Medication Scheme

Defines the medication scheme

Medicine Substitution Reason

The Medicine Substitution Reason value set includes values that may be used to record the reason for medicine substitution.

Medtech HPI-O Status ValueSet

ValueSet to support HPI-O Status

Medtech Patient Account Group ValueSet

ValueSet to support Patient Account Group

Medtech Patient Ethnicity ValueSet

ValueSet to support Patient Ethnicity

Medtech Patient Registration ValueSet

ValueSet to support Patient Registration

Medtech Practitioner Affiliation ValueSet

ValueSet to support practitioner affiliation

Medtech Practitioner HPI-I Status ValueSet

ValueSet to support Practitioner HPI-I Status

Practitioner Role

Defines the Practitioner Role

Priority for Medication Request

Defines the priority for Medication Request

Prompt Value Set for Measurement

Defines the prompt for Measurement

Reason for Request

The Reason for Request value set includes values that can be used to indicate the rationale for a request. For example, this may include the reason for requesting a service or diagnostic procedure.

Route of Administration

Defines the Route of Administration used by ALEX

Route of Administration

The Route of Administration value set includes values that describe the route by which a medicine may be administered.

Screening Term Value Set for observation result

Defines the screening term for observation resource

Status for Allergy Intolerance

Defines the status for Allergy Intolerance

Status for Condition

Defines the status for Condition

Status for Immunisation

Defines the status for immunisation

The DVA Entitlement for Patient

Defines the DVA entitlement valueset

Type of Allergy Intolerance

Defines the type of Allergy Intolerance

Type of Allergy Intolerance Reaction

Defines the type of Allergy Intolerance Reaction

Unit Value Set for Observation Component

Defines the unit for Observation Component

Verification Status for Condition

Defines the verification status for Condition

Writeback Action Type Value Set

Defines the Writeback Action Type in ALEX

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

ANZSIC CodeSystem

CodeSystem for use in the collection, analysis and dissemination of industry classification statistics in Australia and New Zealand.

Allergy Intolerance Manifestation Code

Manifestation Code CodeSystem for Allergy Intolerance

Allergy Intolerance Type CodeSystem

CodeSystem for allergy intolerance type

Australian Indigenous Status

The Australian Indigenous Status code system defines concepts to support the representation of a person's Indigenous status. That is, whether a person identifies as being of Aboriginal or Torres Strait Islander origin, as represented by a code. The concepts defined in this code system are equivalent to those defined in the METeOR value domains for Person Indigenous status code N for http://meteor.aihw.gov.au/content/index.phtml/itemId/602545, http://meteor.aihw.gov.au/content/index.phtml/itemId/270885, and http://meteor.aihw.gov.au/content/index.phtml/itemId/291036.

Australian States and Territories

The Australian States and Territories code system defines concepts that represent the Australian states and territories.

Consultation Note Content Format CodeSystem

Consultation Note Content Format CodeSystem

Daily Frequency CodeSystem

CodeSystem to support dosage daily frequency

Diagnostic Code Code System

Diagnostic Codes

ICPC2 Plus CodeSystem for Condition

ICPC2 Plus CodeSystem for Condition

Immunisation Vaccine Codes

Defines the codes for immunisation vaccine

Individual Healthcare Identifier Record Status

The Individual Healthcare Identifier Record Status code system defines concepts that may be used to describe the classification status of a record of an Individual Healthcare Identifier.

Individual Healthcare Identifier Status

The Individual Healthcare Identifier Status code system defines concepts that may be used to describe the classification status of an Individual Healthcare Identifier.

LOINC CodeSystem

Place holder for loinc codesystem

MIMS CodeSystem

Place holder for mims codesystem

Measurement Prompt CodeSystem

CodeSystem for the Measurement Prompt

Medication Scheme Code System

Medication Scheme Code System

Medtech Ethnicity CodeSystem

CodeSystem to support Patient Ethnicity

Medtech HPI-I status CodeSystem

CodeSystem to support Practitioner HPI-I status

Medtech HPI-O Status CodeSystem

CodeSystem to support HPI-O Status

Medtech Patient Account Group CodeSystem

CodeSystem to support Patient Account Group

Medtech Practitioner Affiliation CodeSystem

CodeSystem to support practitioner affiliation status

Medtech Registration status CodeSystem

CodeSystem to support Patient Registration status

Observation Component Unit CodeSystem

CodeSystem for the Observation Component unit

Observation Interpretation CodeSystem

CodeSystem to support observation interpretation

Route of Administration

CodeSystem to support Route of Administration

SNOMED CodeSystem

Place holder for snomed codesystem

Screening Term CodeSystem

CodeSystem to support observation screening term

Writeback Action Type CodeSystem

CodeSystem to specify the write back action

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

4f5e9b70-b98f-4af6-9a65-b55a1e845169
7c1ea996-d721-458b-97de-408fd4cc1c30
DownUnder Medical Center
allergyIntolerance-full-example
allergyIntolerance-min-notes-example
allergyIntolerance-min-therapeutic-example
allergyIntolerance-search-bundle-example
condition-full-example
condition-min-example
condition-search-bundle-example
consultationNotes-full-example
consultationNotes-min-example
consultationNotes-search-bundle-example
diagnosticReport-full-example
diagnosticReport-min-example
diagnosticReport-search-bundle-example
dischargeSummary-full-example

Test Status Report

dischargeSummary-min-example

Test Status Report

immunisation-full-example
immunisation-min-example
immunisation-search-bundle-example
location-min-example
location-search-bundle-example
medication-request-full-example
medication-request-min-example
medication-request-search-bundle-example
observation-full-example
observation-min-example
observation-search-bundle-example
outbox-full-example
outbox-min-example
outbox-search-bundle-example
patient-full-example
patient-minimum-example
patient-search-bundle-example
practitioner-full-example
practitioner-min-example
practitioner-search-bundle-example
repeat-prescription-full-example
repeat-prescription-min-example
repeat-prescription-post-bundle-example