CodeableConcept
Resource Structure
| CodeableConceptIPS (CodeableConcept) | CodeableConcept | ||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | SO Σ | 0..* | CodingIPS |
| text | SO Σ | 0..1 | string |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| translation | C | 0..* | Extension |
| value | 0..1 | System.String |
Detailed Information
| CodeableConcept | |||||||||
| Short | Concept - reference to a terminology or just text | ||||||||
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | ||||||||
| Cardinality | 0..* | ||||||||
| 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. | ||||||||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||||||||
| Constraints |
| ||||||||
| Mappings |
| ||||||||
| CodeableConcept.id | |||||||||
| 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. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Mappings |
| ||||||||
| CodeableConcept.extension | |||||||||
| 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. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Extension | ||||||||
| Alias | extensions, user content | ||||||||
| 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. | ||||||||
| 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 |
| ||||||||
| Mappings |
| ||||||||
| CodeableConcept.coding | |||||||||
| Short | A reference to a code defined by a terminology system | ||||||||
| Definition | A reference to a code defined by a terminology system. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | CodingIPS | ||||||||
| Must Support | True | ||||||||
| Summary | True | ||||||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||||
| 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. | ||||||||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||||||||
| Constraints |
| ||||||||
| Mappings |
| ||||||||
| Obligations |
| ||||||||
| CodeableConcept.text | |||||||||
| Short | Plain text representation of the concept | ||||||||
| 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. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Must Support | True | ||||||||
| Summary | True | ||||||||
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||||||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||||||||
| Constraints |
| ||||||||
| Mappings |
| ||||||||
| Obligations |
| ||||||||
| CodeableConcept.text.id | |||||||||
| 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. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Mappings |
| ||||||||
| CodeableConcept.text.extension | |||||||||
| 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. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Extension | ||||||||
| Alias | extensions, user content | ||||||||
| 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. | ||||||||
| 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 |
| ||||||||
| Mappings |
| ||||||||
| CodeableConcept.text.extension:translation | |||||||||
| Short | Language Translation (Localization) | ||||||||
| Definition | Language translation from base language of resource to another language. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Extension | ||||||||
| Alias | extensions, user content | ||||||||
| 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. | ||||||||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||||||||
| Constraints |
| ||||||||
| Mappings |
| ||||||||
| CodeableConcept.text.value | |||||||||
| Short | Primitive value for string | ||||||||
| Definition | Primitive value for string | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | System.String | ||||||||
| Maximum string length | 1048576 | ||||||||