3.28 StructureDefinition: Shared Health CodeableConcept Code Required with Text Optional
The official URL for this profile is:
http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code-required-with-text
3.28.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CodeableConcept
Name | Card. | Type | Constraints and Usage |
---|---|---|---|
CodeableConcept | 0..* | CodeableConcept | Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
coding | 1..* | Coding | 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
code | 1..1 | code | 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). Comments: This is the code as defined within the binding. |
text | 0..1 | string | Max Length: 2500 Definition: A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Comments: Conformance Rule: This is the text used to convey the exact word that was displayed to the practitioner |
This structure is derived from CodeableConcept
This structure is derived from CodeableConcept
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeableConcept | 0..* | CodeableConcept | Concept - reference to a terminology or just text | |
coding | S | 1..* | Coding | Code defined by a terminology system |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
text | S | 0..1 | string | Plain text representation of the concept Max Length: 2500 |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeableConcept | 0..* | CodeableConcept | Concept - reference to a terminology or just text | |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | SΣ | 1..* | Coding | Code defined by a terminology system |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..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 |
text | SΣ | 0..1 | string | Plain text representation of the concept Max Length: 2500 |
Documentation for this format |
Grid View
This structure is derived from CodeableConcept
Name | Card. | Type | Constraints and Usage |
---|---|---|---|
CodeableConcept | 0..* | CodeableConcept | Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
coding | 1..* | Coding | 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
code | 1..1 | code | 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). Comments: This is the code as defined within the binding. |
text | 0..1 | string | Max Length: 2500 Definition: A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Comments: Conformance Rule: This is the text used to convey the exact word that was displayed to the practitioner |
This structure is derived from CodeableConcept
Differential View
This structure is derived from CodeableConcept
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeableConcept | 0..* | CodeableConcept | Concept - reference to a terminology or just text | |
coding | S | 1..* | Coding | Code defined by a terminology system |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
text | S | 0..1 | string | Plain text representation of the concept Max Length: 2500 |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeableConcept | 0..* | CodeableConcept | Concept - reference to a terminology or just text | |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | SΣ | 1..* | Coding | Code defined by a terminology system |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..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 |
text | SΣ | 0..1 | string | Plain text representation of the concept Max Length: 2500 |
Documentation for this format |
Other representations of profile: Schematron
3.28.3 Terminology Bindings
3.28.4 Constraints
Constraints
Id | Path | Details | Requirements |