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
Data Type Profile: Coding resource for NZ Formulary
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzfCoding | Version: 1.0.0 | |||
| Active as of 2025-01-19 | Computable Name: NzfCoding | |||
Coding resource for NZ Formulary
Usage:
- This DataType Constraint is not used by any profiles in this Implementation Guide
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Coding |
0..* | Coding | A reference to a code defined by a terminology system ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource | |
  Slices for extension |
Content/Rules for all slices | |||
   isPrimary |
0..1 | boolean | Is primary code within given context, e.g. primary pharmacode when multiple given URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-is-primary-coding ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children unless an empty Parameters resource : hasValue() or (children().count() > id.count()) or $this is Parameters | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Coding
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Coding |
0..* | Coding | A reference to a code defined by a terminology system | |
| Slices for extension |
Content/Rules for all slices | |||
| isPrimary |
0..1 | boolean | Is primary code within given context, e.g. primary pharmacode when multiple given URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-is-primary-coding | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Coding |
0..* | Coding | A reference to a code defined by a terminology system | |
  id |
0..1 | id | Unique id for inter-element referencing | |
  Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
 isPrimary |
0..1 | boolean | Is primary code within given context, e.g. primary pharmacode when multiple given URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-is-primary-coding | |
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| version |
Σ | 0..1 | string | Version of the system - if relevant |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
 userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children unless an empty Parameters resource : hasValue() or (children().count() > id.count()) or $this is Parameters | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Coding
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Coding |
0..* | Coding | A reference to a code defined by a terminology system ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource | |
| Slices for extension |
Content/Rules for all slices | |||
| isPrimary |
0..1 | boolean | Is primary code within given context, e.g. primary pharmacode when multiple given URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-is-primary-coding ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children unless an empty Parameters resource : hasValue() or (children().count() > id.count()) or $this is Parameters | |
| 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 Coding
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Coding |
0..* | Coding | A reference to a code defined by a terminology system | |
| Slices for extension |
Content/Rules for all slices | |||
| isPrimary |
0..1 | boolean | Is primary code within given context, e.g. primary pharmacode when multiple given URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-is-primary-coding | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Coding |
0..* | Coding | A reference to a code defined by a terminology system | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| isPrimary |
0..1 | boolean | Is primary code within given context, e.g. primary pharmacode when multiple given URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-is-primary-coding | |
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| version |
Σ | 0..1 | string | Version of the system - if relevant |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children unless an empty Parameters resource : hasValue() or (children().count() > id.count()) or $this is Parameters | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Coding
Other representations of profile: CSV, Excel, Schematron