Name	Flags	Card.	Type	Description & Constraints
MedicationStatement		0..*	MedicationStatementIPS	Record of medication being taken by a patient This profile also imposes the profile MedicationStatement resource for use in NZ dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	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. ele-1: All FHIR elements must have a @value or children
Slices for medication[x]	SΣ	1..1		What medication was taken Slice: Unordered, Open by type:$this Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication ele-1: All FHIR elements must have a @value or children
medicationReference			Reference(Medication (IPS))
medicationCodeableConcept			CodeableConcept(CodeableConceptIPS)
medication[x]:medicationCodeableConcept	SΣ	0..1	CodeableConceptIPS	What medication was taken Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication ele-1: All FHIR elements must have a @value or children
Slices for coding	S	0..*	CodingIPS	A reference to a code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
coding:NZMT	S	0..*	CodingIPS	New Zealand Medicines Terminology Binding: http://nzmt.org.nz/vs (preferred) ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:nzf-nzmt-tpe		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type Binding: https://nzhts.digital.health.nz/fhir/ValueSet/nzmt-type (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
system	SΣ	1..1	uri	Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://nzmt.org.nz/vs
code	SΣ	0..1	code	Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	Representation defined by the system ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
coding:GTIN	S	0..*	CodingIPS	Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred) ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://www.gs1.org/gtin
code	SΣ	0..1	code	Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	Representation defined by the system ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
text	SΣ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
subject	SΣ	1..1	Reference(Patient (IPS))	Who is/was taking the medication ele-1: All FHIR elements must have a @value or children
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
effective[x]	SΣ	1..1		The date/time or interval when the medication is/was/will be taken ele-1: All FHIR elements must have a @value or children
effective[x]All Types				Content/Rules for all Types
Slices for extension				Content/Rules for all slices
extension:data-absent-reason	S	0..1	code	effective[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
effectiveDateTime			dateTime
effectivePeriod			Period
dosage	S	0..*	Dosage	Details of how medication is/was taken or should be taken ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
text	SΣ	0..1	string	Free text dosage instructions e.g. SIG ele-1: All FHIR elements must have a @value or children
timing	SΣ	0..1	Timing	When medication should be administered ele-1: All FHIR elements must have a @value or children
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]	preferred	MedicationSnomedCodesAbsentUnknown http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips
MedicationStatement.medication[x]:medicationCodeableConcept	preferred	MedicationSnomedCodesAbsentUnknown http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMT	preferred	http://nzmt.org.nz/vs http://nzmt.org.nz/vs
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTIN	preferred	GTIN http://terminology.hl7.org/ValueSet/v3-GTIN

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()

Name	Flags	Card.	Type	Description & Constraints
MedicationStatement		0..*	MedicationStatementIPS	Record of medication being taken by a patient This profile also imposes the profile MedicationStatement resource for use in NZ
Slices for medication[x]		1..1	Reference(Medication (IPS)), CodeableConceptIPS	What medication was taken Slice: Unordered, Open by type:$this
medication[x]:medicationCodeableConcept		0..1	CodeableConceptIPS	What medication was taken
Slices for coding		0..*	CodingIPS	A reference to a code defined by a terminology system Slice: Unordered, Open by value:system
coding:NZMT		0..*	CodingIPS	New Zealand Medicines Terminology Binding: http://nzmt.org.nz/vs (preferred)
Slices for extension				Content/Rules for all slices
extension:nzf-nzmt-tpe		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type Binding: https://nzhts.digital.health.nz/fhir/ValueSet/nzmt-type (required)
system		1..1	uri	Identity of the terminology system Fixed Value: http://nzmt.org.nz/vs
coding:GTIN		0..*	CodingIPS	Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred)
system		1..1	uri	Identity of the terminology system Fixed Value: http://www.gs1.org/gtin
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMT	preferred	http://nzmt.org.nz/vs http://nzmt.org.nz/vs
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTIN	preferred	GTIN http://terminology.hl7.org/ValueSet/v3-GTIN

Name	Flags	Card.	Type	Description & Constraints
MedicationStatement		0..*	MedicationStatementIPS	Record of medication being taken by a patient This profile also imposes the profile MedicationStatement resource for use in NZ
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
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	?!Σ	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]	SΣ	1..1		What medication was taken Slice: Unordered, Open by type:$this Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication
medicationReference			Reference(Medication (IPS))
medicationCodeableConcept			CodeableConcept(CodeableConceptIPS)
medication[x]:medicationCodeableConcept	SΣ	0..1	CodeableConceptIPS	What medication was taken Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown 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
Slices for coding	S	0..*	CodingIPS	A reference to a code defined by a terminology system Slice: Unordered, Open by value:system
coding:NZMT	S	0..*	CodingIPS	New Zealand Medicines Terminology Binding: http://nzmt.org.nz/vs (preferred)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:nzf-nzmt-tpe		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type Binding: https://nzhts.digital.health.nz/fhir/ValueSet/nzmt-type (required)
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: http://nzmt.org.nz/vs
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
value		0..1	string	Primitive value for string Max Length:1048576
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:GTIN	S	0..*	CodingIPS	Medication Package Global Trade Item Number (GTIN) Binding: 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
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: http://www.gs1.org/gtin
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
value		0..1	string	Primitive value for string Max Length:1048576
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	SΣ	0..1	string	Plain text representation of the concept
subject	SΣ	1..1	Reference(Patient (IPS))	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]	SΣ	1..1		The date/time or interval when the medication is/was/will be taken
effective[x]All Types				Content/Rules for all Types
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:data-absent-reason	S	0..1	code	effective[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
effectiveDateTime			dateTime
effectivePeriod			Period
dateAsserted	Σ	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		0..*	CodeableConcept	Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken.
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Condition or observation that supports why the medication is being/was taken
note		0..*	Annotation	Further information about the statement
dosage	S	0..*	Dosage	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	SΣ	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 (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
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: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
site	Σ	0..1	CodeableConcept	Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
route		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred): EDQM Standards Terms
method	Σ	0..1	CodeableConcept	Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
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]	preferred	MedicationSnomedCodesAbsentUnknown http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips
MedicationStatement.medication[x]:medicationCodeableConcept	preferred	MedicationSnomedCodesAbsentUnknown http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMT	preferred	http://nzmt.org.nz/vs http://nzmt.org.nz/vs
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTIN	preferred	GTIN http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationStatement.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
MedicationStatement.reasonCode	example	Condition/Problem/DiagnosisCodes http://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard
MedicationStatement.dosage.additionalInstruction	example	SNOMEDCTAdditionalDosageInstructions http://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard
MedicationStatement.dosage.asNeeded[x]	example	SNOMEDCTMedicationAsNeededReasonCodes http://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard
MedicationStatement.dosage.site	example	SNOMEDCTAnatomicalStructureForAdministrationSiteCodes http://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard
MedicationStatement.dosage.route	preferred	MedicineRouteOfAdministrationUvIps http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
MedicationStatement.dosage.method	example	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()

Summary

Mandatory: 0 element(2 nested mandatory elements)
Fixed: 2 elements

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)

Extensions

This structure refers to these extensions:

• http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of MedicationStatement.medication[x]
• The element 1 is sliced based on the value of MedicationStatement.medication[x].coding

Name	Flags	Card.	Type	Description & Constraints
MedicationStatement		0..*	MedicationStatementIPS	Record of medication being taken by a patient This profile also imposes the profile MedicationStatement resource for use in NZ dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	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. ele-1: All FHIR elements must have a @value or children
Slices for medication[x]	SΣ	1..1		What medication was taken Slice: Unordered, Open by type:$this Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication ele-1: All FHIR elements must have a @value or children
medicationReference			Reference(Medication (IPS))
medicationCodeableConcept			CodeableConcept(CodeableConceptIPS)
medication[x]:medicationCodeableConcept	SΣ	0..1	CodeableConceptIPS	What medication was taken Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication ele-1: All FHIR elements must have a @value or children
Slices for coding	S	0..*	CodingIPS	A reference to a code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
coding:NZMT	S	0..*	CodingIPS	New Zealand Medicines Terminology Binding: http://nzmt.org.nz/vs (preferred) ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:nzf-nzmt-tpe		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type Binding: https://nzhts.digital.health.nz/fhir/ValueSet/nzmt-type (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
system	SΣ	1..1	uri	Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://nzmt.org.nz/vs
code	SΣ	0..1	code	Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	Representation defined by the system ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
coding:GTIN	S	0..*	CodingIPS	Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred) ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://www.gs1.org/gtin
code	SΣ	0..1	code	Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	Representation defined by the system ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
text	SΣ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
subject	SΣ	1..1	Reference(Patient (IPS))	Who is/was taking the medication ele-1: All FHIR elements must have a @value or children
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
effective[x]	SΣ	1..1		The date/time or interval when the medication is/was/will be taken ele-1: All FHIR elements must have a @value or children
effective[x]All Types				Content/Rules for all Types
Slices for extension				Content/Rules for all slices
extension:data-absent-reason	S	0..1	code	effective[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
effectiveDateTime			dateTime
effectivePeriod			Period
dosage	S	0..*	Dosage	Details of how medication is/was taken or should be taken ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
text	SΣ	0..1	string	Free text dosage instructions e.g. SIG ele-1: All FHIR elements must have a @value or children
timing	SΣ	0..1	Timing	When medication should be administered ele-1: All FHIR elements must have a @value or children
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]	preferred	MedicationSnomedCodesAbsentUnknown http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips
MedicationStatement.medication[x]:medicationCodeableConcept	preferred	MedicationSnomedCodesAbsentUnknown http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMT	preferred	http://nzmt.org.nz/vs http://nzmt.org.nz/vs
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTIN	preferred	GTIN http://terminology.hl7.org/ValueSet/v3-GTIN

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()

Name	Flags	Card.	Type	Description & Constraints
MedicationStatement		0..*	MedicationStatementIPS	Record of medication being taken by a patient This profile also imposes the profile MedicationStatement resource for use in NZ
Slices for medication[x]		1..1	Reference(Medication (IPS)), CodeableConceptIPS	What medication was taken Slice: Unordered, Open by type:$this
medication[x]:medicationCodeableConcept		0..1	CodeableConceptIPS	What medication was taken
Slices for coding		0..*	CodingIPS	A reference to a code defined by a terminology system Slice: Unordered, Open by value:system
coding:NZMT		0..*	CodingIPS	New Zealand Medicines Terminology Binding: http://nzmt.org.nz/vs (preferred)
Slices for extension				Content/Rules for all slices
extension:nzf-nzmt-tpe		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type Binding: https://nzhts.digital.health.nz/fhir/ValueSet/nzmt-type (required)
system		1..1	uri	Identity of the terminology system Fixed Value: http://nzmt.org.nz/vs
coding:GTIN		0..*	CodingIPS	Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred)
system		1..1	uri	Identity of the terminology system Fixed Value: http://www.gs1.org/gtin
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMT	preferred	http://nzmt.org.nz/vs http://nzmt.org.nz/vs
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTIN	preferred	GTIN http://terminology.hl7.org/ValueSet/v3-GTIN

Name	Flags	Card.	Type	Description & Constraints
MedicationStatement		0..*	MedicationStatementIPS	Record of medication being taken by a patient This profile also imposes the profile MedicationStatement resource for use in NZ
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
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	?!Σ	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]	SΣ	1..1		What medication was taken Slice: Unordered, Open by type:$this Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication
medicationReference			Reference(Medication (IPS))
medicationCodeableConcept			CodeableConcept(CodeableConceptIPS)
medication[x]:medicationCodeableConcept	SΣ	0..1	CodeableConceptIPS	What medication was taken Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown 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
Slices for coding	S	0..*	CodingIPS	A reference to a code defined by a terminology system Slice: Unordered, Open by value:system
coding:NZMT	S	0..*	CodingIPS	New Zealand Medicines Terminology Binding: http://nzmt.org.nz/vs (preferred)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:nzf-nzmt-tpe		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type Binding: https://nzhts.digital.health.nz/fhir/ValueSet/nzmt-type (required)
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: http://nzmt.org.nz/vs
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
value		0..1	string	Primitive value for string Max Length:1048576
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:GTIN	S	0..*	CodingIPS	Medication Package Global Trade Item Number (GTIN) Binding: 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
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: http://www.gs1.org/gtin
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
value		0..1	string	Primitive value for string Max Length:1048576
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	SΣ	0..1	string	Plain text representation of the concept
subject	SΣ	1..1	Reference(Patient (IPS))	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]	SΣ	1..1		The date/time or interval when the medication is/was/will be taken
effective[x]All Types				Content/Rules for all Types
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:data-absent-reason	S	0..1	code	effective[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
effectiveDateTime			dateTime
effectivePeriod			Period
dateAsserted	Σ	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		0..*	CodeableConcept	Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken.
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Condition or observation that supports why the medication is being/was taken
note		0..*	Annotation	Further information about the statement
dosage	S	0..*	Dosage	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	SΣ	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 (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
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: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
site	Σ	0..1	CodeableConcept	Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
route		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred): EDQM Standards Terms
method	Σ	0..1	CodeableConcept	Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
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]	preferred	MedicationSnomedCodesAbsentUnknown http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips
MedicationStatement.medication[x]:medicationCodeableConcept	preferred	MedicationSnomedCodesAbsentUnknown http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMT	preferred	http://nzmt.org.nz/vs http://nzmt.org.nz/vs
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTIN	preferred	GTIN http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationStatement.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
MedicationStatement.reasonCode	example	Condition/Problem/DiagnosisCodes http://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard
MedicationStatement.dosage.additionalInstruction	example	SNOMEDCTAdditionalDosageInstructions http://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard
MedicationStatement.dosage.asNeeded[x]	example	SNOMEDCTMedicationAsNeededReasonCodes http://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard
MedicationStatement.dosage.site	example	SNOMEDCTAnatomicalStructureForAdministrationSiteCodes http://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard
MedicationStatement.dosage.route	preferred	MedicineRouteOfAdministrationUvIps http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
MedicationStatement.dosage.method	example	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()

Summary

Mandatory: 0 element(2 nested mandatory elements)
Fixed: 2 elements

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)

Extensions

This structure refers to these extensions:

• http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of MedicationStatement.medication[x]
• The element 1 is sliced based on the value of MedicationStatement.medication[x].coding