Medicines Data Repository Implementation Guide, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/mdr/ and changes regularly. See the Directory of published versions
Extension: NZePS Endorsement
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement | Version: 0.1.0 | |||
| Draft as of 2020-07-20 | Computable Name: NzepsEndorsement | |||
Copyright/Legal: HL7 New Zealand© 2020+; Licensed Under Creative Commons No Rights Reserved. |
||||
NZ ePrescription (NZePS) Endorsements
Represents the NZePS Endorsement Class. This consists of (coded) Type, Value and (optionally) Expiry Date properties.
Context of Use
This extension may be used on the following element(s):
- Element ID MedicationRequest
- Element ID MedicationDispense
Usage info
Usage:
- Use this Extension: Medication Dispense resource for use in NZ e-Prescription Service MDR and Medication Request resource for use in the NZ e-Prescription Service MDR
- Examples for this Extension: Bundle/0c463c87-f6b1-4909-a7e9-df126054cffc and Bundle/b7cbd26f-7d7b-48fe-9bda-e8dc5ce1901a
Formal Views of Extension Content
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension |
0..* | Extension | NZePS Endorsement | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:endorsementType |
0..1 | Extension | Extension | |
   extension |
0..0 | |||
| url |
1..1 | uri | "endorsementType" | |
  value[x] |
0..1 | CodeableConcept | Value of extension Binding: http://hl7.org.nz/fhir/ValueSet/nzeps-endorsement-type (required) | |
| extension:value |
0..1 | Extension | Extension | |
| extension |
0..0 | |||
| url |
1..1 | uri | "value" | |
 value[x] |
0..1 | string | Value of extension | |
 extension:expiryDate |
0..1 | Extension | Extension | |
 extension |
0..0 | |||
| url |
1..1 | uri | "expiryDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
 url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement" | |
 value[x] |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | NZePS Endorsement | |
| 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:endorsementType |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "endorsementType" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: http://hl7.org.nz/fhir/ValueSet/nzeps-endorsement-type (required) | |
| extension:value |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "value" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:expiryDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "expiryDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement" | |
| Documentation for this format | ||||
This structure is derived from Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | NZePS Endorsement | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:endorsementType |
0..1 | Extension | Extension | |
| extension |
0..0 | |||
| url |
1..1 | uri | "endorsementType" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: http://hl7.org.nz/fhir/ValueSet/nzeps-endorsement-type (required) | |
| extension:value |
0..1 | Extension | Extension | |
| extension |
0..0 | |||
| url |
1..1 | uri | "value" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:expiryDate |
0..1 | Extension | Extension | |
| extension |
0..0 | |||
| url |
1..1 | uri | "expiryDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement" | |
| value[x] |
0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | NZePS Endorsement | |
| 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:endorsementType |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "endorsementType" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: http://hl7.org.nz/fhir/ValueSet/nzeps-endorsement-type (required) | |
| extension:value |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "value" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:expiryDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "expiryDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement" | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Extension.extension:endorsementType.value[x] | required | http://hl7.org.nz/fhir/ValueSet/nzeps-endorsement-typehttp://hl7.org.nz/fhir/ValueSet/nzeps-endorsement-type |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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() |