FHIR New Zealand Patient Summary IG
0.7.0 - ci-build
FHIR New Zealand Patient Summary IG
0.7.0 - ci-build
FHIR New Zealand Patient Summary IG, published by Health NZ | Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.7.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-nzps/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-medication | Version: 0.7.0 | |||
| Active as of 2026-05-04 | 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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  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
| ||||||||||||||||
| 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. | ||||||||||||||||
| form |
SO | 0..1 | CodeableConceptIPS | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (preferred): SNOMED Doseform Terms
| ||||||||||||||||
 ingredient |
SO | 0..* | BackboneElement | Active or inactive ingredient
| ||||||||||||||||
 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
| |||||||||||||||||
 itemCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||||||
  itemReference |
Reference(Substance | Medication) | |||||||||||||||||||
| strength |
SO | 0..1 | Ratio | Quantity of ingredient present
| ||||||||||||||||
| Documentation for this format | ||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.code | Base | preferred | Medications - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| Medication.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| Medication.form | Base | preferred | SNOMED CT Form Codes | 📦4.0.1 | FHIR Std. |
| Medication.ingredient.item[x] | Base | preferred | Medicine Active Substances - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Medication | 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 MedicationIPS
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Medication |
0..* | MedicationIPS | Definition of a Medication This profile also imposes the profile Medication resource for use in NZ | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 | ||||||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||||||
| 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
| ||||||||||||||||
| 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
| ||||||||||||||||
| amount |
Σ | 0..1 | Ratio | Amount of drug in package | ||||||||||||||||
| ingredient |
SO | 0..* | BackboneElement | Active or inactive ingredient
| ||||||||||||||||
| 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
| |||||||||||||||||
| itemCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||||||
| itemReference |
Reference(Substance | Medication) | |||||||||||||||||||
| isActive |
0..1 | boolean | Active ingredient indicator | |||||||||||||||||
| strength |
SO | 0..1 | Ratio | Quantity of ingredient present
| ||||||||||||||||
| 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 | |||||||||||||||||
| Documentation for this format | ||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Medication.code | Base | preferred | Medications - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| Medication.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| Medication.form | Base | preferred | SNOMED CT Form Codes | 📦4.0.1 | FHIR Std. |
| Medication.ingredient.item[x] | Base | preferred | Medicine Active Substances - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Medication | 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 MedicationIPS
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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
| ||||||||||||||||
| 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. | ||||||||||||||||
| form |
SO | 0..1 | CodeableConceptIPS | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (preferred): SNOMED Doseform Terms
| ||||||||||||||||
| ingredient |
SO | 0..* | BackboneElement | Active or inactive ingredient
| ||||||||||||||||
| 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
| |||||||||||||||||
| itemCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||||||
| itemReference |
Reference(Substance | Medication) | |||||||||||||||||||
| strength |
SO | 0..1 | Ratio | Quantity of ingredient present
| ||||||||||||||||
| Documentation for this format | ||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.code | Base | preferred | Medications - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| Medication.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| Medication.form | Base | preferred | SNOMED CT Form Codes | 📦4.0.1 | FHIR Std. |
| Medication.ingredient.item[x] | Base | preferred | Medicine Active Substances - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Medication | 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 MedicationIPS
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Medication |
0..* | MedicationIPS | Definition of a Medication This profile also imposes the profile Medication resource for use in NZ | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 | ||||||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||||||
| 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
| ||||||||||||||||
| 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
| ||||||||||||||||
| amount |
Σ | 0..1 | Ratio | Amount of drug in package | ||||||||||||||||
| ingredient |
SO | 0..* | BackboneElement | Active or inactive ingredient
| ||||||||||||||||
| 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
| |||||||||||||||||
| itemCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||||||
| itemReference |
Reference(Substance | Medication) | |||||||||||||||||||
| isActive |
0..1 | boolean | Active ingredient indicator | |||||||||||||||||
| strength |
SO | 0..1 | Ratio | Quantity of ingredient present
| ||||||||||||||||
| 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 | |||||||||||||||||
| Documentation for this format | ||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Medication.code | Base | preferred | Medications - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| Medication.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| Medication.form | Base | preferred | SNOMED CT Form Codes | 📦4.0.1 | FHIR Std. |
| Medication.ingredient.item[x] | Base | preferred | Medicine Active Substances - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Medication | 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 MedicationIPS
Other representations of profile: CSV, Excel, Schematron