HL7 FHIR Implementation Guide - New Zealand Formulary/NZULM IG
1.0.0 - ci-build
HL7 FHIR Implementation Guide - New Zealand Formulary/NZULM IG, published by New Zealand Medicines Formulary LP. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzf/ and changes regularly. See the Directory of published versions
Active as of 2024-10-23 |
XML representation of the NzfCoding data type profile.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="NzfCoding"/>
<text>
<status value="additional"/>
<div xmlns="http://www.w3.org/1999/xhtml">Coding</div>
</text>
<url value="http://hl7.org.nz/fhir/StructureDefinition/NzfCoding"/>
<version value="1.0.0"/>
<name value="NzfCoding"/>
<title value="Coding resource for NZ Formulary"/>
<status value="active"/>
<date value="2024-10-23T20:14:14+00:00"/>
<publisher value="New Zealand Medicines Formulary LP"/>
<contact>
<name value="New Zealand Medicines Formulary LP"/>
<telecom>
<system value="email"/>
<value value="mailto:fhir@nzformulary.org"/>
</telecom>
</contact>
<description value="Coding resource for NZ Formulary"/>
<fhirVersion value="4.3.0"/>
<mapping>
<identity value="v2"/>
<uri value="http://hl7.org/v2"/>
<name value="HL7 v2 Mapping"/>
</mapping>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<mapping>
<identity value="orim"/>
<uri value="http://hl7.org/orim"/>
<name value="Ontological RIM Mapping"/>
</mapping>
<kind value="complex-type"/>
<abstract value="false"/>
<type value="Coding"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Coding"/>
<derivation value="constraint"/>
<snapshot>
<element id="Coding">
<path value="Coding"/>
<short value="A reference to a code defined by a terminology system"/>
<definition
value="A reference to a code defined by a terminology system."/>
<comment
value="Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Coding"/>
<min value="0"/>
<max value="*"/>
</base>
<condition value="ele-1"/>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human
value="All FHIR elements must have a @value or children unless an empty Parameters resource"/>
<expression
value="hasValue() or (children().count() > id.count()) or $this is Parameters"/>
<xpath value="@value|f:*|h:div|self::f:Parameters"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
<mapping>
<identity value="v2"/>
<map
value="CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="CV"/>
</mapping>
<mapping>
<identity value="orim"/>
<map value="fhir:Coding rdfs:subClassOf dt:CDCoding"/>
</mapping>
</element>
<element id="Coding.id">
<path value="Coding.id"/>
<representation value="xmlAttr"/>
<short value="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="id"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Coding.extension">
<path value="Coding.extension"/>
<slicing>
<discriminator>
<type value="value"/>
<path value="url"/>
</discriminator>
<description value="Extensions are always sliced by (at least) url"/>
<rules value="open"/>
</slicing>
<short value="Additional content defined by implementations"/>
<definition
value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/>
<comment
value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Coding.extension:isPrimary">
<path value="Coding.extension"/>
<sliceName value="isPrimary"/>
<short
value="Is primary code within given context, e.g. primary pharmacode when multiple given"/>
<definition
value="Is primary code within given context, e.g. primary Pharmacode® when multiple given"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
<profile
value="http://hl7.org.nz/fhir/StructureDefinition/nzf-is-primary-coding"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Coding.system">
<path value="Coding.system"/>
<short value="Identity of the terminology system"/>
<definition
value="The identification of the code system that defines the meaning of the symbol in the code."/>
<comment
value="The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously."/>
<requirements
value="Need to be unambiguous about the source of the definition of the symbol."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Coding.system"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="C*E.3"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="./codeSystem"/>
</mapping>
<mapping>
<identity value="orim"/>
<map
value="fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"/>
</mapping>
</element>
<element id="Coding.version">
<path value="Coding.version"/>
<short value="Version of the system - if relevant"/>
<definition
value="The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged."/>
<comment
value="Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Coding.version"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="C*E.7"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="./codeSystemVersion"/>
</mapping>
<mapping>
<identity value="orim"/>
<map
value="fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"/>
</mapping>
</element>
<element id="Coding.code">
<extension
url="http://hl7.org/fhir/build/StructureDefinition/no-binding">
<valueBoolean value="true"/>
</extension>
<path value="Coding.code"/>
<short value="Symbol in syntax defined by the system"/>
<definition
value="A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)."/>
<requirements
value="Need to refer to a particular code in the system."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Coding.code"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="C*E.1"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="./code"/>
</mapping>
<mapping>
<identity value="orim"/>
<map value="fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"/>
</mapping>
</element>
<element id="Coding.display">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<path value="Coding.display"/>
<short value="Representation defined by the system"/>
<definition
value="A representation of the meaning of the code in the system, following the rules of the system."/>
<requirements
value="Need to be able to carry a human-readable meaning of the code for readers that do not know the system."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Coding.display"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="C*E.2 - but note this is not well followed"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="CV.displayName"/>
</mapping>
<mapping>
<identity value="orim"/>
<map
value="fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"/>
</mapping>
</element>
<element id="Coding.userSelected">
<path value="Coding.userSelected"/>
<short value="If this coding was chosen directly by the user"/>
<definition
value="Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays)."/>
<comment
value="Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely."/>
<requirements
value="This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Coding.userSelected"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="Sometimes implied by being first"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="CD.codingRationale"/>
</mapping>
<mapping>
<identity value="orim"/>
<map
value="fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]"/>
</mapping>
</element>
</snapshot>
<differential>
<element id="Coding">
<path value="Coding"/>
</element>
<element id="Coding.extension:isPrimary">
<path value="Coding.extension"/>
<sliceName value="isPrimary"/>
<short
value="Is primary code within given context, e.g. primary pharmacode when multiple given"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Extension"/>
<profile
value="http://hl7.org.nz/fhir/StructureDefinition/nzf-is-primary-coding"/>
</type>
</element>
</differential>
</StructureDefinition>