International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Coding-uv-ips | Version: 2.0.0 | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: CodingIPS |
This profile extends the capabilities of the coding data type to support multi-language designations (display). It relies on the Translation extension.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Coding
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coding | Coding | |||
system | S | 0..1 | uri | Identity of the terminology system |
code | S | 0..1 | code | Symbol in syntax defined by the system |
display | S | 0..1 | string | Representation defined by the system |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
translation | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coding | 0..* | Coding | A reference to a code defined by a terminology system | |
system | SΣ | 0..1 | uri | Identity of the terminology system |
code | SΣ | 0..1 | code | Symbol in syntax defined by the system |
display | SΣ | 0..1 | string | Representation defined by the system |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
translation | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coding | 0..* | Coding | A reference to a code defined by a terminology system | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | SΣ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 0..1 | code | Symbol in syntax defined by the system |
display | SΣ | 0..1 | string | Representation defined by the system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
translation | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Coding
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coding | Coding | |||
system | S | 0..1 | uri | Identity of the terminology system |
code | S | 0..1 | code | Symbol in syntax defined by the system |
display | S | 0..1 | string | Representation defined by the system |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
translation | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coding | 0..* | Coding | A reference to a code defined by a terminology system | |
system | SΣ | 0..1 | uri | Identity of the terminology system |
code | SΣ | 0..1 | code | Symbol in syntax defined by the system |
display | SΣ | 0..1 | string | Representation defined by the system |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
translation | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coding | 0..* | Coding | A reference to a code defined by a terminology system | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | SΣ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 0..1 | code | Symbol in syntax defined by the system |
display | SΣ | 0..1 | string | Representation defined by the system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
translation | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Other representations of profile: CSV, Excel, Schematron