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/HL7/fhir-ips/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 2 |
Definitions for the Coding-uv-ips data type profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Coding | |||||||||
| Definition | A reference to a code defined by a terminology system. | ||||||||
| Short | 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. | ||||||||
| 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. Coding.system | |||||||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||||||
| Short | Identity of the terminology system | ||||||||
| 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. | ||||||||
| Control | 0..1 | ||||||||
| Type | uri | ||||||||
| 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 | Need to be unambiguous about the source of the definition of the symbol. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 4. Coding.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). | ||||||||
| Short | Symbol in syntax defined by the system | ||||||||
| Control | 0..1 | ||||||||
| Type | code | ||||||||
| 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 | Need to refer to a particular code in the system. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 6. Coding.display | |||||||||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||||||
| Short | Representation defined by the system | ||||||||
| 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 | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 8. Coding.display.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 Coding.display.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 10. Coding.display.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. Coding | |||||||||
| 2. Coding.system | |||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 4. Coding.code | |||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 6. Coding.display | |||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 8. Coding.display.extension | |||||||||
| Slicing | This element introduces a set of slices on Coding.display.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 10. Coding.display.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. Coding | |||||||||
| Definition | A reference to a code defined by a terminology system. | ||||||||
| Short | 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. | ||||||||
| 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. Coding.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. Coding.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 Coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 6. Coding.system | |||||||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||||||
| Short | Identity of the terminology system | ||||||||
| 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. | ||||||||
| Control | 0..1 | ||||||||
| Type | uri | ||||||||
| 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 | Need to be unambiguous about the source of the definition of the symbol. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 8. Coding.version | |||||||||
| 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. | ||||||||
| Short | Version of the system - if relevant | ||||||||
| 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. | ||||||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||||||
| Control | 0..1 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 10. Coding.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). | ||||||||
| Short | Symbol in syntax defined by the system | ||||||||
| Control | 0..1 | ||||||||
| Type | code | ||||||||
| 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 | Need to refer to a particular code in the system. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 12. Coding.display | |||||||||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||||||
| Short | Representation defined by the system | ||||||||
| 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 | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 14. Coding.display.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 | ||||||||
| 16. Coding.display.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 Coding.display.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 18. Coding.display.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()) | ||||||||
| 20. Coding.display.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 | ||||||||
| 22. Coding.userSelected | |||||||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||||||
| Short | If this coding was chosen directly by the user | ||||||||
| 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. | ||||||||
| Control | 0..1 | ||||||||
| Type | boolean | ||||||||
| Is Modifier | false | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Summary | true | ||||||||
| 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. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
IG © 2020+ HL7 International / Patient Care. Package hl7.fhir.uv.ips#2.0.0 based on FHIR 4.0.1. Generated 2025-07-02
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change