International Patient Summary Implementation Guide
2.0.0 - STU 2
International Patient Summary Implementation Guide
2.0.0 - STU 2
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/costateixeira/fhir-ips/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 2 |
Definitions for the CodeableConcept-uv-ips data type profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. CodeableConcept | |||||||||
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | ||||||||
| Short | Concept - reference to a terminology or just 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. | ||||||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||||||
| Is Modifier | false | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2. CodeableConcept.coding | |||||||||
| Definition | A reference to a code defined by a terminology system. | ||||||||
| Short | 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 labeled as UserSelected = true. | ||||||||
| Control | 0..* | ||||||||
| Type | Coding(Coding with translations) | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 4. CodeableConcept.text | |||||||||
| 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. | ||||||||
| Short | Plain text representation of the concept | ||||||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||||||
| Control | 0..1 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 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. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 6. CodeableConcept.text.extension | |||||||||
| Definition | An Extension 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. | ||||||||
| Short | ExtensionAdditional content defined by implementations | ||||||||
| 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. | ||||||||
| Control | 0..* | ||||||||
| Type | Extension | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | extensions, user content | ||||||||
| Invariants | 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())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||
| Slicing | This element introduces a set of slices on CodeableConcept.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 8. CodeableConcept.text.extension:translation | |||||||||
| Slice Name | translation | ||||||||
| Definition | Language translation from base language of resource to another language. | ||||||||
| Short | Language Translation (Localization) | ||||||||
| Control | 0..* | ||||||||
| Type | Extension(Translation) (Complex Extension) | ||||||||
| Is Modifier | false | ||||||||
| Invariants | 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()) | ||||||||
Guidance on how to interpret the contents of this table can be foundhere
| 0. CodeableConcept | |||||||||
| 2. CodeableConcept.coding | |||||||||
| Type | Coding(Coding with translations) | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 4. CodeableConcept.text | |||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 6. CodeableConcept.text.extension | |||||||||
| Slicing | This element introduces a set of slices on CodeableConcept.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 8. CodeableConcept.text.extension:translation | |||||||||
| Slice Name | translation | ||||||||
| Short | Language Translation (Localization) | ||||||||
| Control | 0..* | ||||||||
| Type | Extension(Translation) (Complex Extension) | ||||||||
Guidance on how to interpret the contents of this table can be foundhere
| 0. CodeableConcept | |||||||||
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | ||||||||
| Short | Concept - reference to a terminology or just 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. | ||||||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||||||
| Is Modifier | false | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2. CodeableConcept.id | |||||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||
| Short | Unique id for inter-element referencing | ||||||||
| Control | 0..1 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 4. CodeableConcept.extension | |||||||||
| 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. | ||||||||
| Short | Additional content defined by implementations | ||||||||
| 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. | ||||||||
| Control | 0..* | ||||||||
| Type | Extension | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | extensions, user content | ||||||||
| Invariants | 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()) | ||||||||
| Slicing | This element introduces a set of slices on CodeableConcept.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 6. CodeableConcept.coding | |||||||||
| Definition | A reference to a code defined by a terminology system. | ||||||||
| Short | 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 labeled as UserSelected = true. | ||||||||
| Control | 0..* | ||||||||
| Type | Coding(Coding with translations) | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 8. CodeableConcept.text | |||||||||
| 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. | ||||||||
| Short | Plain text representation of the concept | ||||||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||||||
| Control | 0..1 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 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. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 10. CodeableConcept.text.id | |||||||||
| Definition | unique id for the element within a resource (for internal references) | ||||||||
| Short | xml:id (or equivalent in JSON) | ||||||||
| Control | 0..1 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 12. CodeableConcept.text.extension | |||||||||
| Definition | An Extension | ||||||||
| Short | Extension | ||||||||
| Control | 0..* | ||||||||
| Type | Extension | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Invariants | 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()) | ||||||||
| Slicing | This element introduces a set of slices on CodeableConcept.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 14. CodeableConcept.text.extension:translation | |||||||||
| Slice Name | translation | ||||||||
| Definition | Language translation from base language of resource to another language. | ||||||||
| Short | Language Translation (Localization) | ||||||||
| Control | 0..* | ||||||||
| Type | Extension(Translation) (Complex Extension) | ||||||||
| Is Modifier | false | ||||||||
| Invariants | 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()) | ||||||||
| 16. CodeableConcept.text.value | |||||||||
| Definition | The actual value | ||||||||
| Short | Primitive value for string | ||||||||
| Control | 0..1 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| Max Length: | 1048576 | ||||||||
IG © 2020+ HL7 International / Patient Care. Package hl7.fhir.uv.ips#2.0.0 based on FHIR 4.0.1. Generated 2025-08-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change