Medicines Data Repository Implementation Guide
0.1.0 - ci-build

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 Realm: New Zealand flag 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:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Complex Extension: NZ ePrescription (NZePS) Endorsements

  • endorsementType: CodeableConcept: The type of endorsement
  • value: string: The endorsement value
  • expiryDate: dateTime: The date the endorsement expires

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension NZePS Endorsement
... 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
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)
.... 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"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: NZ ePrescription (NZePS) Endorsements

  • endorsementType: CodeableConcept: The type of endorsement
  • value: string: The endorsement value
  • expiryDate: dateTime: The date the endorsement expires

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension NZePS Endorsement
... 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
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)
.... 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"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:endorsementType.value[x]requiredhttp://hl7.org.nz/fhir/ValueSet/nzeps-endorsement-type
http://hl7.org.nz/fhir/ValueSet/nzeps-endorsement-type

Constraints

IdGradePath(s)DetailsRequirements
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()