FHIR New Zealand Patient Summary IG
0.7.0 - ci-build NZ

FHIR New Zealand Patient Summary IG - Local Development build (v0.7.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: NZPS-Medication

Official URL: https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-medication Version: 0.7.0
Active as of 2026-04-10 Realm: New Zealand flag Computable Name: NZPSMedication

Medication as referenced by the MedicationStatement resource constrained by this profile. Based on the IPS profile.

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* MedicationIPS Definition of a Medication
This profile also imposes the profile Medication resource for use in NZ
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code SOΣ 1..1 CodeableConceptIPS Medication that was administered or was to be administered (medication code from any code system)
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
Additional BindingsPurpose
WHO ATC - IPS candidate
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
... form SO 0..1 CodeableConceptIPS powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (preferred): SNOMED Doseform Terms
Additional BindingsPurpose
Medicine EDQM Doseform - IPS candidate
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
... ingredient SO 0..* BackboneElement Active or inactive ingredient
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] SO 1..1 The actual ingredient or content
Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
..... itemCodeableConcept CodeableConcept(CodeableConceptIPS)
..... itemReference Reference(Substance | Medication)
.... strength SO 0..1 Ratio Quantity of ingredient present
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codepreferredMedicationsUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ips
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
From the FHIR Standard
Medication.formpreferredSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
From the FHIR Standard
Medication.ingredient.item[x]preferredMedicineActiveSubstancesUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ips

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MedicationIPS

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* MedicationIPS Definition of a Medication
This profile also imposes the profile Medication resource for use in NZ

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* MedicationIPS Definition of a Medication
This profile also imposes the profile Medication 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
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code SOΣ 1..1 CodeableConceptIPS Medication that was administered or was to be administered (medication code from any code system)
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
Additional BindingsPurpose
WHO ATC - IPS candidate
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
... manufacturer Σ 0..1 Reference(Organization) Manufacturer of the item
... form SO 0..1 CodeableConceptIPS powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (preferred): SNOMED Doseform Terms
Additional BindingsPurpose
Medicine EDQM Doseform - IPS candidate
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
... amount Σ 0..1 Ratio Amount of drug in package
... ingredient SO 0..* BackboneElement Active or inactive ingredient
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] SO 1..1 The actual ingredient or content
Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
..... itemCodeableConcept CodeableConcept(CodeableConceptIPS)
..... itemReference Reference(Substance | Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength SO 0..1 Ratio Quantity of ingredient present
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
... batch 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Medication.codepreferredMedicationsUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ips
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
From the FHIR Standard
Medication.formpreferredSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
From the FHIR Standard
Medication.ingredient.item[x]preferredMedicineActiveSubstancesUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ips

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MedicationIPS

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* MedicationIPS Definition of a Medication
This profile also imposes the profile Medication resource for use in NZ
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code SOΣ 1..1 CodeableConceptIPS Medication that was administered or was to be administered (medication code from any code system)
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
Additional BindingsPurpose
WHO ATC - IPS candidate
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
... form SO 0..1 CodeableConceptIPS powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (preferred): SNOMED Doseform Terms
Additional BindingsPurpose
Medicine EDQM Doseform - IPS candidate
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
... ingredient SO 0..* BackboneElement Active or inactive ingredient
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] SO 1..1 The actual ingredient or content
Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
..... itemCodeableConcept CodeableConcept(CodeableConceptIPS)
..... itemReference Reference(Substance | Medication)
.... strength SO 0..1 Ratio Quantity of ingredient present
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codepreferredMedicationsUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ips
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
From the FHIR Standard
Medication.formpreferredSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
From the FHIR Standard
Medication.ingredient.item[x]preferredMedicineActiveSubstancesUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ips

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from MedicationIPS

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* MedicationIPS Definition of a Medication
This profile also imposes the profile Medication resource for use in NZ

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* MedicationIPS Definition of a Medication
This profile also imposes the profile Medication 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
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code SOΣ 1..1 CodeableConceptIPS Medication that was administered or was to be administered (medication code from any code system)
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
Additional BindingsPurpose
WHO ATC - IPS candidate
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
... manufacturer Σ 0..1 Reference(Organization) Manufacturer of the item
... form SO 0..1 CodeableConceptIPS powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (preferred): SNOMED Doseform Terms
Additional BindingsPurpose
Medicine EDQM Doseform - IPS candidate
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
... amount Σ 0..1 Ratio Amount of drug in package
... ingredient SO 0..* BackboneElement Active or inactive ingredient
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] SO 1..1 The actual ingredient or content
Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
..... itemCodeableConcept CodeableConcept(CodeableConceptIPS)
..... itemReference Reference(Substance | Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength SO 0..1 Ratio Quantity of ingredient present
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Medication (IPS)
SHALL:handle Consumer (IPS) from Medication (IPS)
SHOULD:display Consumer (IPS) from Medication (IPS)
... batch 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Medication.codepreferredMedicationsUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ips
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
From the FHIR Standard
Medication.formpreferredSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
From the FHIR Standard
Medication.ingredient.item[x]preferredMedicineActiveSubstancesUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ips

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MedicationIPS

Summary

 

Other representations of profile: CSV, Excel, Schematron