Visit the HL7 website
Visit the FHIR website

Primary Care

current   Canada flag
  • Index
  • Home
  • Business Context
    • Architectural Considerations
    • Use Cases
    • Future Enhancements
    • Consolidation Methodology
  • Technical Context
    • Conformance Guidance
    • Mappings
  • FHIR Artifacts
    • FHIR Artifacts
    • Actors
    • Profiles
    • Extensions
    • Search
    • Data Types
    • Capability Statement
    • Terminology
    • Examples
    • Packages
  • Change Log
    1. Index
    2. FHIR Artifacts
    3. Data Types
    4. Coding

dft-preBallot - This is the first draft of the P-Care IG. For a full list of available versions, see the Directory of published versions

Coding

Links

Profile

coding

Derived from

http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/coding-ca-core

Examples

Description

A reference to a code defined by a terminology system.

References to this resource

Resource Content

  • Tree view
  • Overview
  • XML
  • JSON
PCareCoding (Coding)CodingCACore
There are no (further) constraints on this element
Element id
Coding
Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Comments

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.

Data type

CodingCACore

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
id0..1string
There are no (further) constraints on this element
Element id
Coding.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Coding.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
systemO Σ0..1uriElement id
Coding.system
Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

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.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHOULD:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
versionΣ0..1string
There are no (further) constraints on this element
Element id
Coding.version
Short description

Version of the system - if relevant

Definition

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.

Comments

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
codeO Σ0..1codeElement id
Coding.code
Short description

Symbol in syntax defined by the system

Definition

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

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHOULD:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
displayO Σ0..1stringElement id
Coding.display
Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHOULD:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
id0..1string
There are no (further) constraints on this element
Element id
Coding.display.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Coding.display.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
translationC0..*Extension(Complex)Element id
Coding.display.extension:translation
Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

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.

Data type

Extension(Complex)

Extension URL

Translation

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
  • rim: ST.translation
value0..1System.String
There are no (further) constraints on this element
Element id
Coding.display.value
Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelectedΣ0..1boolean
There are no (further) constraints on this element
Element id
Coding.userSelected
Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

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.

Comments

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.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: 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 ]
PCareCoding (Coding)CodingCACore
There are no (further) constraints on this element
Element id
Coding
Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Comments

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.

Data type

CodingCACore

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
id0..1string
There are no (further) constraints on this element
Element id
Coding.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Coding.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
systemO Σ0..1uri
There are no (further) constraints on this element
Element id
Coding.system
Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

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.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHOULD:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/coding|0.1.0
versionΣ0..1string
There are no (further) constraints on this element
Element id
Coding.version
Short description

Version of the system - if relevant

Definition

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.

Comments

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
codeO Σ0..1code
There are no (further) constraints on this element
Element id
Coding.code
Short description

Symbol in syntax defined by the system

Definition

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

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHOULD:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/coding|0.1.0
displayO Σ0..1string
There are no (further) constraints on this element
Element id
Coding.display
Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHOULD:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/coding|0.1.0
id0..1string
There are no (further) constraints on this element
Element id
Coding.display.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Coding.display.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
translationC0..*Extension(Complex)
There are no (further) constraints on this element
Element id
Coding.display.extension:translation
Short description

Language Translation (Localization)

Definition

Language translation from base language of resource to another language.

Data type

Extension(Complex)

Extension URL

Translation

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: ST.translation
value0..1System.String
There are no (further) constraints on this element
Element id
Coding.display.value
Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelectedΣ0..1boolean
There are no (further) constraints on this element
Element id
Coding.userSelected
Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

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.

Comments

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.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: 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 ]
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="coding" />
<text>
<status value="extensions" />
--- We have skipped the narrative for better readability of the resource ---
</text>
<url value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/coding" />
<version value="0.1.0" />
<name value="PCareCoding" />
<title value="P-Care Coding" />
<status value="draft" />
<date value="2026-10-19T22:14:59+00:00" />
<publisher value="Infoway" />
<description value="A reference to a code defined by a terminology system." />
<fhirVersion value="4.0.1" />
<kind value="complex-type" />
<abstract value="false" />
<type value="Coding" />
<baseDefinition value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/coding-ca-core" />
<derivation value="constraint" />
<snapshot>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
<valueString value="1.1.0" />
</extension>
<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" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<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="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<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>
<condition value="ele-1" />
<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>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Coding.system">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHOULD:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/coding|0.1.0" />
</extension>
</extension>
<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>
<condition value="ele-1" />
<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>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<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>
<condition value="ele-1" />
<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>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<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/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHOULD:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/coding|0.1.0" />
</extension>
</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)." />
<comment value="Note that FHIR strings SHALL NOT exceed 1MB in size" />
<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>
<condition value="ele-1" />
<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>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<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/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHOULD:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/coding|0.1.0" />
</extension>
</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." />
<comment value="Note that FHIR strings SHALL NOT exceed 1MB in size" />
<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>
<condition value="ele-1" />
<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>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<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.display.id">
<path value="Coding.display.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="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="Coding.display.extension">
<path value="Coding.display.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>
<condition value="ele-1" />
<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>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Coding.display.extension:translation">
<path value="Coding.display.extension" />
<sliceName value="translation" />
<short value="Language Translation (Localization)" />
<definition value="Language translation from base language of resource to another language." />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
<profile value="http://hl7.org/fhir/StructureDefinition/translation|5.3.0" />
</type>
<condition value="ele-1" />
<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>
<mapping>
<identity value="rim" />
<map value="ST.translation" />
</mapping>
</element>
<element id="Coding.display.value">
<path value="Coding.display.value" />
<representation value="xmlAttr" />
<short value="Primitive value for string" />
<definition value="Primitive value for string" />
<min value="0" />
<max value="1" />
<base>
<path value="string.value" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/regex">
<valueString value="[\r\n\t\u0020-\uFFFF]*" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<maxLength value="1048576" />
</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>
<condition value="ele-1" />
<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>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<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.system">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHOULD:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="Coding.system" />
</element>
<element id="Coding.code">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHOULD:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="Coding.code" />
</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/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHOULD:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="Coding.display" />
</element>
<element id="Coding.display.extension:translation">
<path value="Coding.display.extension" />
<sliceName value="translation" />
<definition value="Language translation from base language of resource to another language." />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "coding",
"text": {
"status": "extensions",
--- We have skipped the narrative for better readability of the resource ---
},
"url": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/coding",
"version": "0.1.0",
"name": "PCareCoding",
"title": "P-Care Coding",
"status": "draft",
"date": "2026-10-19T22:14:59+00:00",
"publisher": "Infoway",
"description": "A reference to a code defined by a terminology system.",
"fhirVersion": "4.0.1",
"kind": "complex-type",
"abstract": false,
"type": "Coding",
"baseDefinition": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/coding-ca-core",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "1.1.0"
}
],
"element": [
{
"id": "Coding",
"path": "Coding",
"short": "A reference to a code defined by a terminology system",
"definition": "A reference to a code defined by a terminology system.",
"comment": "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": 0,
"max": "*",
"base": {
"path": "Coding",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity": "rim",
"map": "CV"
},
{
"identity": "orim",
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding"
}
]
},
{
"id": "Coding.id",
"path": "Coding.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Coding.extension",
"path": "Coding.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "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": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Coding.system",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHOULD:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/coding|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Coding.system",
"short": "Identity of the terminology system",
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"comment": "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": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "C*E.3"
},
{
"identity": "rim",
"map": "./codeSystem"
},
{
"identity": "orim",
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
}
]
},
{
"id": "Coding.version",
"path": "Coding.version",
"short": "Version of the system - if relevant",
"definition": "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": "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": 0,
"max": "1",
"base": {
"path": "Coding.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "C*E.7"
},
{
"identity": "rim",
"map": "./codeSystemVersion"
},
{
"identity": "orim",
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
}
]
},
{
"id": "Coding.code",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHOULD:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/coding|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Coding.code",
"short": "Symbol in syntax defined by the system",
"definition": "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).",
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "C*E.1"
},
{
"identity": "rim",
"map": "./code"
},
{
"identity": "orim",
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
}
]
},
{
"id": "Coding.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHOULD:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/coding|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Coding.display",
"short": "Representation defined by the system",
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "C*E.2 - but note this is not well followed"
},
{
"identity": "rim",
"map": "CV.displayName"
},
{
"identity": "orim",
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
}
]
},
{
"id": "Coding.display.id",
"path": "Coding.display.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Coding.display.extension",
"path": "Coding.display.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "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": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Coding.display.extension:translation",
"path": "Coding.display.extension",
"sliceName": "translation",
"short": "Language Translation (Localization)",
"definition": "Language translation from base language of resource to another language.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/translation|5.3.0"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "ST.translation"
}
]
},
{
"id": "Coding.display.value",
"path": "Coding.display.value",
"representation": [
"xmlAttr"
],
"short": "Primitive value for string",
"definition": "Primitive value for string",
"min": 0,
"max": "1",
"base": {
"path": "string.value",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[\\r\\n\\t\\u0020-\\uFFFF]*"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"maxLength": 1048576
},
{
"id": "Coding.userSelected",
"path": "Coding.userSelected",
"short": "If this coding was chosen directly by the user",
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"comment": "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": "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": 0,
"max": "1",
"base": {
"path": "Coding.userSelected",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "Sometimes implied by being first"
},
{
"identity": "rim",
"map": "CD.codingRationale"
},
{
"identity": "orim",
"map": "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 ]"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Coding.system",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHOULD:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Coding.system"
},
{
"id": "Coding.code",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHOULD:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Coding.code"
},
{
"id": "Coding.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHOULD:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Coding.display"
},
{
"id": "Coding.display.extension:translation",
"path": "Coding.display.extension",
"sliceName": "translation",
"definition": "Language translation from base language of resource to another language."
}
]
}
}

Constraints

Obligations

ElementActorCode
codehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHOULD:persist, SHALL:no-error
displayhttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHOULD:persist, SHALL:no-error
systemhttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHOULD:persist, SHALL:no-error

Terminology bindings (Differential)

Terminology bindings (Snapshot)

Additional Terminology Bindings Only

IG © based on FHIR R4 | template version 2.5.1 | Package project:p-care
Copyright © 2026 Canada Health Infoway. All rights reserved. Terms of Use & License Agreements. Privacy Policy.
HL7® and FHIR® are the registered trademarks of Health Level Seven International