DRAFT AU Patient Summary Implementation Guide for Testing, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.1.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/draft-au-patient-summary/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Resource Profile: EXPERIMENTAL AU PS MedicationStatement ( Experimental )

This profile is based on the AU Core profile, the additional IPS rules are manually applied, and the target references for elements flagged with Must Support changed to EXPERIMENTAL AU PS profiles. This profile is compliant to IPS MedicationStatement profile. For IG Publisher to allow for this profile to be referenced by a Composition profile or Bundle profile that is derived from IPS, some formal declaration is required to be provided otherwise a build error is triggered. At this time compliesWithProfile is used in preference to imposeProfile. This is the expected approach for the HL7 AU Patient Summary FHIR IG.

Usages:

• Use this Profile: EXPERIMENTAL AU PS Bundle
• Refer to this Profile: EXPERIMENTAL AU PS Composition

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MedicationStatement		0..*	AUCoreMedicationStatement	A record of medication being taken by a patient in an Australian healthcare context This profile also complies with the profile MedicationStatement (IPS)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:longTerm		0..1	boolean	Medication Long Term Indicator URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SOΣ	1..1	code	active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.
Slices for medication[x]	SOΣ	1..1		Medication Detail Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Any)
medication[x]:medicationCodeableConcept	SOΣ	0..1	CodeableConceptIPS	Coded Medication Binding: SNOMEDCTMedicationCodes (example) Additional Bindings Purpose Australian Medication Preferred PBS Item Codes Preferred MIMS Preferred GTIN Preferred
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:All Slices				Content/Rules for all slices
Slices for extension				Content/Rules for all slices
extension:medicationClass		0..1	Coding	Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
coding:pbs	SOΣ	0..*	Coding	Code defined by a terminology system Binding: PBS Item Codes (required)
Slices for extension				Content/Rules for all slices
extension:medicationClass		0..1	Coding	Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
coding:amt	SOΣ	0..*	Coding	Code defined by a terminology system Binding: Australian Medication (required)
Slices for extension				Content/Rules for all slices
extension:medicationClass		0..1	Coding	Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
medication[x]:medicationReference	SOΣ	0..1	Reference(EXPERIMENTAL AU PS Medication)	Medication Reference
subject	SOΣ	1..1	Reference(EXPERIMENTAL AU PS Patient)	Who is/was taking the medication
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
effective[x]	SOΣ	1..1		The date/time or interval when the medication is/was/will be taken
effectiveDateTime			dateTime
effectivePeriod			Period
dateAsserted	SOΣ	0..1	dateTime	When the statement was asserted?
reasonCode	SO	0..*	CodeableConcept	Reason for why the medication is being/was taken Binding: Medication Reason Taken (preferred)
reasonReference	SO	0..*	Reference(EXPERIMENTAL AU PS Condition | Observation | DiagnosticReport (IPS))	Condition or observation that supports why the medication is being/was taken
dosage	SO	0..*	AUBaseDosage	Details of how medication is/was taken or should be taken
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text	SOΣ	0..1	string	Free text dosage instructions e.g. SIG
timing	SΣ	0..1	Timing	When medication should be administered
route	Σ	0..1	CodeableConceptIPS	How drug should enter body Binding: Route of Administration (preferred)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
MedicationStatement.status	required	Medication Status Codes http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 From the FHIR Standard
MedicationStatement.medication[x]	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes From the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes From the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs	required	PBSItemCodes http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt	required	AustralianMedication https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 From https://tx.ontoserver.csiro.au/fhir
MedicationStatement.reasonCode	preferred	MedicationReasonTaken https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 From https://tx.ontoserver.csiro.au/fhir
MedicationStatement.dosage.route	preferred	RouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 From https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MedicationStatement	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MedicationStatement	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	MedicationStatement	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	MedicationStatement	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MedicationStatement	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from AUCoreMedicationStatement

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MedicationStatement			AUCoreMedicationStatement	This profile also complies with the profile MedicationStatement (IPS)
Slices for medication[x]				Content/Rules for all slices
medication[x]:medicationCodeableConcept		0..1	CodeableConceptIPS	Coded Medication
medication[x]:medicationReference		0..1	Reference(EXPERIMENTAL AU PS Medication)	Medication Reference
subject		1..1	Reference(EXPERIMENTAL AU PS Patient)	Who is/was taking the medication
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
effective[x]		1..1	dateTime, Period	The date/time or interval when the medication is/was/will be taken
reasonReference		0..*	Reference(EXPERIMENTAL AU PS Condition | Observation | DiagnosticReport (IPS))	Condition or observation that supports why the medication is being/was taken
dosage
timing	S	0..1	Timing	When medication should be administered
route		0..1	CodeableConceptIPS	How drug should enter body
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MedicationStatement		0..*	AUCoreMedicationStatement	A record of medication being taken by a patient in an Australian healthcare context This profile also complies with the profile MedicationStatement (IPS)
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:longTerm		0..1	boolean	Medication Long Term Indicator URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External identifier
basedOn	Σ	0..*	Reference(MedicationRequest | CarePlan | ServiceRequest)	Fulfils plan, proposal or order
partOf	Σ	0..*	Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation)	Part of referenced event
status	?!SOΣ	1..1	code	active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.
statusReason		0..*	CodeableConcept	Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.
category	Σ	0..1	CodeableConcept	Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.
Slices for medication[x]	SOΣ	1..1		Medication Detail Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Any)
medication[x]:medicationCodeableConcept	SOΣ	0..1	CodeableConceptIPS	Coded Medication Binding: SNOMEDCTMedicationCodes (example) Additional Bindings Purpose Australian Medication Preferred PBS Item Codes Preferred MIMS Preferred GTIN Preferred
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:medicationClass		0..1	Coding	Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:pbs	SOΣ	0..*	Coding	Code defined by a terminology system Binding: PBS Item Codes (required)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:medicationClass		0..1	Coding	Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:amt	SOΣ	0..*	Coding	Code defined by a terminology system Binding: Australian Medication (required)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:medicationClass		0..1	Coding	Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Medication primary text
medication[x]:medicationReference	SOΣ	0..1	Reference(EXPERIMENTAL AU PS Medication)	Medication Reference
subject	SOΣ	1..1	Reference(EXPERIMENTAL AU PS Patient)	Who is/was taking the medication
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
context	Σ	0..1	Reference(Encounter | EpisodeOfCare)	Encounter / Episode associated with MedicationStatement
effective[x]	SOΣ	1..1		The date/time or interval when the medication is/was/will be taken
effectiveDateTime			dateTime
effectivePeriod			Period
dateAsserted	SOΣ	0..1	dateTime	When the statement was asserted?
informationSource		0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)	Person or organization that provided the information about the taking of this medication
derivedFrom		0..*	Reference(Resource)	Additional supporting information
reasonCode	SO	0..*	CodeableConcept	Reason for why the medication is being/was taken Binding: Medication Reason Taken (preferred)
reasonReference	SO	0..*	Reference(EXPERIMENTAL AU PS Condition | Observation | DiagnosticReport (IPS))	Condition or observation that supports why the medication is being/was taken
note		0..*	Annotation	Further information about the statement
dosage	SO	0..*	AUBaseDosage	Details of how medication is/was taken or should be taken
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
sequence	Σ	0..1	integer	The order of the dosage instructions
text	SOΣ	0..1	string	Free text dosage instructions e.g. SIG
additionalInstruction	Σ	0..*	CodeableConcept	Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
patientInstruction	Σ	0..1	string	Patient or consumer oriented instructions
timing	SΣ	0..1	Timing	When medication should be administered
asNeeded[x]	Σ	0..1		Take "as needed" (for x) Binding: Clinical Finding (preferred)
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
site	Σ	0..1	CodeableConcept	Body site to administer to Binding: Body Site (preferred)
route	Σ	0..1	CodeableConceptIPS	How drug should enter body Binding: Route of Administration (preferred)
method	Σ	0..1	CodeableConcept	Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred)
doseAndRate	Σ	0..*	Element	Amount of medication administered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	0..1	CodeableConcept	The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified.
dose[x]	Σ	0..1		Amount of medication per dose
doseRange			Range
doseQuantity			Quantity(SimpleQuantity)
rate[x]	Σ	0..1		Amount of medication per unit of time
rateRatio			Ratio
rateRange			Range
rateQuantity			Quantity(SimpleQuantity)
maxDosePerPeriod	Σ	0..1	Ratio	Upper limit on medication per unit of time
maxDosePerAdministration	Σ	0..1	SimpleQuantity	Upper limit on medication per administration
maxDosePerLifetime	Σ	0..1	SimpleQuantity	Upper limit on medication per lifetime of the patient
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
MedicationStatement.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
MedicationStatement.status	required	Medication Status Codes http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 From the FHIR Standard
MedicationStatement.statusReason	example	SNOMEDCTDrugTherapyStatusCodes http://hl7.org/fhir/ValueSet/reason-medication-status-codes From the FHIR Standard
MedicationStatement.category	preferred	Medication usage category codes http://hl7.org/fhir/ValueSet/medication-statement-category From the FHIR Standard
MedicationStatement.medication[x]	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes From the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes From the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs	required	PBSItemCodes http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt	required	AustralianMedication https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 From https://tx.ontoserver.csiro.au/fhir
MedicationStatement.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
MedicationStatement.reasonCode	preferred	MedicationReasonTaken https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 From https://tx.ontoserver.csiro.au/fhir
MedicationStatement.dosage.additionalInstruction	preferred	SNOMEDCTAdditionalDosageInstructions http://hl7.org/fhir/ValueSet/additional-instruction-codes From the FHIR Standard
MedicationStatement.dosage.asNeeded[x]	preferred	ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 From https://tx.ontoserver.csiro.au/fhir
MedicationStatement.dosage.site	preferred	BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 From https://tx.ontoserver.csiro.au/fhir
MedicationStatement.dosage.route	preferred	RouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 From https://tx.ontoserver.csiro.au/fhir
MedicationStatement.dosage.method	preferred	SNOMEDCTAdministrationMethodCodes http://hl7.org/fhir/ValueSet/administration-method-codes From the FHIR Standard
MedicationStatement.dosage.doseAndRate.type	example	DoseAndRateType http://hl7.org/fhir/ValueSet/dose-rate-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MedicationStatement	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MedicationStatement	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	MedicationStatement	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	MedicationStatement	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MedicationStatement	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from AUCoreMedicationStatement

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
• EXPERIMENTAL AU PS Medication (http://hl7.org.au.draft/fhir/aups/StructureDefinition/au-exp-ps-medication)
• EXPERIMENTAL AU PS Patient (http://hl7.org.au.draft/fhir/aups/StructureDefinition/au-exp-ps-patient)
• EXPERIMENTAL AU PS Condition (http://hl7.org.au.draft/fhir/aups/StructureDefinition/au-exp-ps-condition)
• DiagnosticReport (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/DiagnosticReport-uv-ips)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MedicationStatement		0..*	AUCoreMedicationStatement	A record of medication being taken by a patient in an Australian healthcare context This profile also complies with the profile MedicationStatement (IPS)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:longTerm		0..1	boolean	Medication Long Term Indicator URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SOΣ	1..1	code	active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.
Slices for medication[x]	SOΣ	1..1		Medication Detail Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Any)
medication[x]:medicationCodeableConcept	SOΣ	0..1	CodeableConceptIPS	Coded Medication Binding: SNOMEDCTMedicationCodes (example) Additional Bindings Purpose Australian Medication Preferred PBS Item Codes Preferred MIMS Preferred GTIN Preferred
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:All Slices				Content/Rules for all slices
Slices for extension				Content/Rules for all slices
extension:medicationClass		0..1	Coding	Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
coding:pbs	SOΣ	0..*	Coding	Code defined by a terminology system Binding: PBS Item Codes (required)
Slices for extension				Content/Rules for all slices
extension:medicationClass		0..1	Coding	Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
coding:amt	SOΣ	0..*	Coding	Code defined by a terminology system Binding: Australian Medication (required)
Slices for extension				Content/Rules for all slices
extension:medicationClass		0..1	Coding	Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
medication[x]:medicationReference	SOΣ	0..1	Reference(EXPERIMENTAL AU PS Medication)	Medication Reference
subject	SOΣ	1..1	Reference(EXPERIMENTAL AU PS Patient)	Who is/was taking the medication
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
effective[x]	SOΣ	1..1		The date/time or interval when the medication is/was/will be taken
effectiveDateTime			dateTime
effectivePeriod			Period
dateAsserted	SOΣ	0..1	dateTime	When the statement was asserted?
reasonCode	SO	0..*	CodeableConcept	Reason for why the medication is being/was taken Binding: Medication Reason Taken (preferred)
reasonReference	SO	0..*	Reference(EXPERIMENTAL AU PS Condition | Observation | DiagnosticReport (IPS))	Condition or observation that supports why the medication is being/was taken
dosage	SO	0..*	AUBaseDosage	Details of how medication is/was taken or should be taken
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text	SOΣ	0..1	string	Free text dosage instructions e.g. SIG
timing	SΣ	0..1	Timing	When medication should be administered
route	Σ	0..1	CodeableConceptIPS	How drug should enter body Binding: Route of Administration (preferred)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
MedicationStatement.status	required	Medication Status Codes http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 From the FHIR Standard
MedicationStatement.medication[x]	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes From the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes From the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs	required	PBSItemCodes http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt	required	AustralianMedication https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 From https://tx.ontoserver.csiro.au/fhir
MedicationStatement.reasonCode	preferred	MedicationReasonTaken https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 From https://tx.ontoserver.csiro.au/fhir
MedicationStatement.dosage.route	preferred	RouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 From https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MedicationStatement	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MedicationStatement	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	MedicationStatement	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	MedicationStatement	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MedicationStatement	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from AUCoreMedicationStatement

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MedicationStatement			AUCoreMedicationStatement	This profile also complies with the profile MedicationStatement (IPS)
Slices for medication[x]				Content/Rules for all slices
medication[x]:medicationCodeableConcept		0..1	CodeableConceptIPS	Coded Medication
medication[x]:medicationReference		0..1	Reference(EXPERIMENTAL AU PS Medication)	Medication Reference
subject		1..1	Reference(EXPERIMENTAL AU PS Patient)	Who is/was taking the medication
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
effective[x]		1..1	dateTime, Period	The date/time or interval when the medication is/was/will be taken
reasonReference		0..*	Reference(EXPERIMENTAL AU PS Condition | Observation | DiagnosticReport (IPS))	Condition or observation that supports why the medication is being/was taken
dosage
timing	S	0..1	Timing	When medication should be administered
route		0..1	CodeableConceptIPS	How drug should enter body
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MedicationStatement		0..*	AUCoreMedicationStatement	A record of medication being taken by a patient in an Australian healthcare context This profile also complies with the profile MedicationStatement (IPS)
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:longTerm		0..1	boolean	Medication Long Term Indicator URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External identifier
basedOn	Σ	0..*	Reference(MedicationRequest | CarePlan | ServiceRequest)	Fulfils plan, proposal or order
partOf	Σ	0..*	Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation)	Part of referenced event
status	?!SOΣ	1..1	code	active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.
statusReason		0..*	CodeableConcept	Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.
category	Σ	0..1	CodeableConcept	Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.
Slices for medication[x]	SOΣ	1..1		Medication Detail Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Any)
medication[x]:medicationCodeableConcept	SOΣ	0..1	CodeableConceptIPS	Coded Medication Binding: SNOMEDCTMedicationCodes (example) Additional Bindings Purpose Australian Medication Preferred PBS Item Codes Preferred MIMS Preferred GTIN Preferred
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:medicationClass		0..1	Coding	Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:pbs	SOΣ	0..*	Coding	Code defined by a terminology system Binding: PBS Item Codes (required)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:medicationClass		0..1	Coding	Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:amt	SOΣ	0..*	Coding	Code defined by a terminology system Binding: Australian Medication (required)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:medicationClass		0..1	Coding	Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Medication primary text
medication[x]:medicationReference	SOΣ	0..1	Reference(EXPERIMENTAL AU PS Medication)	Medication Reference
subject	SOΣ	1..1	Reference(EXPERIMENTAL AU PS Patient)	Who is/was taking the medication
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
context	Σ	0..1	Reference(Encounter | EpisodeOfCare)	Encounter / Episode associated with MedicationStatement
effective[x]	SOΣ	1..1		The date/time or interval when the medication is/was/will be taken
effectiveDateTime			dateTime
effectivePeriod			Period
dateAsserted	SOΣ	0..1	dateTime	When the statement was asserted?
informationSource		0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)	Person or organization that provided the information about the taking of this medication
derivedFrom		0..*	Reference(Resource)	Additional supporting information
reasonCode	SO	0..*	CodeableConcept	Reason for why the medication is being/was taken Binding: Medication Reason Taken (preferred)
reasonReference	SO	0..*	Reference(EXPERIMENTAL AU PS Condition | Observation | DiagnosticReport (IPS))	Condition or observation that supports why the medication is being/was taken
note		0..*	Annotation	Further information about the statement
dosage	SO	0..*	AUBaseDosage	Details of how medication is/was taken or should be taken
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
sequence	Σ	0..1	integer	The order of the dosage instructions
text	SOΣ	0..1	string	Free text dosage instructions e.g. SIG
additionalInstruction	Σ	0..*	CodeableConcept	Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
patientInstruction	Σ	0..1	string	Patient or consumer oriented instructions
timing	SΣ	0..1	Timing	When medication should be administered
asNeeded[x]	Σ	0..1		Take "as needed" (for x) Binding: Clinical Finding (preferred)
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
site	Σ	0..1	CodeableConcept	Body site to administer to Binding: Body Site (preferred)
route	Σ	0..1	CodeableConceptIPS	How drug should enter body Binding: Route of Administration (preferred)
method	Σ	0..1	CodeableConcept	Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred)
doseAndRate	Σ	0..*	Element	Amount of medication administered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	0..1	CodeableConcept	The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified.
dose[x]	Σ	0..1		Amount of medication per dose
doseRange			Range
doseQuantity			Quantity(SimpleQuantity)
rate[x]	Σ	0..1		Amount of medication per unit of time
rateRatio			Ratio
rateRange			Range
rateQuantity			Quantity(SimpleQuantity)
maxDosePerPeriod	Σ	0..1	Ratio	Upper limit on medication per unit of time
maxDosePerAdministration	Σ	0..1	SimpleQuantity	Upper limit on medication per administration
maxDosePerLifetime	Σ	0..1	SimpleQuantity	Upper limit on medication per lifetime of the patient
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
MedicationStatement.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
MedicationStatement.status	required	Medication Status Codes http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 From the FHIR Standard
MedicationStatement.statusReason	example	SNOMEDCTDrugTherapyStatusCodes http://hl7.org/fhir/ValueSet/reason-medication-status-codes From the FHIR Standard
MedicationStatement.category	preferred	Medication usage category codes http://hl7.org/fhir/ValueSet/medication-statement-category From the FHIR Standard
MedicationStatement.medication[x]	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes From the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes From the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs	required	PBSItemCodes http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt	required	AustralianMedication https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 From https://tx.ontoserver.csiro.au/fhir
MedicationStatement.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
MedicationStatement.reasonCode	preferred	MedicationReasonTaken https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 From https://tx.ontoserver.csiro.au/fhir
MedicationStatement.dosage.additionalInstruction	preferred	SNOMEDCTAdditionalDosageInstructions http://hl7.org/fhir/ValueSet/additional-instruction-codes From the FHIR Standard
MedicationStatement.dosage.asNeeded[x]	preferred	ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 From https://tx.ontoserver.csiro.au/fhir
MedicationStatement.dosage.site	preferred	BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 From https://tx.ontoserver.csiro.au/fhir
MedicationStatement.dosage.route	preferred	RouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 From https://tx.ontoserver.csiro.au/fhir
MedicationStatement.dosage.method	preferred	SNOMEDCTAdministrationMethodCodes http://hl7.org/fhir/ValueSet/administration-method-codes From the FHIR Standard
MedicationStatement.dosage.doseAndRate.type	example	DoseAndRateType http://hl7.org/fhir/ValueSet/dose-rate-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MedicationStatement	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MedicationStatement	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	MedicationStatement	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	MedicationStatement	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MedicationStatement	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from AUCoreMedicationStatement

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
• EXPERIMENTAL AU PS Medication (http://hl7.org.au.draft/fhir/aups/StructureDefinition/au-exp-ps-medication)
• EXPERIMENTAL AU PS Patient (http://hl7.org.au.draft/fhir/aups/StructureDefinition/au-exp-ps-patient)
• EXPERIMENTAL AU PS Condition (http://hl7.org.au.draft/fhir/aups/StructureDefinition/au-exp-ps-condition)
• DiagnosticReport (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/DiagnosticReport-uv-ips)

Other representations of profile: CSV, Excel, Schematron