International Patient Summary Implementation Guide
2.0.0 -

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

## Data Type Profile: Codeable Concept (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips | Version: 2.0.0
Standards status: Trial-use Active as of 2024-06-19 | Maturity Level: 3 | Computable Name: CodeableConceptIPS

This profile represents the constraint applied to the CodeableConcept data type by the International Patient Summary (IPS) FHIR Implementation Guide to use the Coding-uv-ips data type profile.

Usages:

- Use this DataType Profile: AllergyIntolerance (IPS), Composition (IPS), Condition (IPS), Device (IPS)... Show 16 more, DiagnosticReport (IPS), Flag - Alert (IPS), ImagingStudy (IPS), Immunization (IPS), Medication (IPS), MedicationRequest (IPS), MedicationStatement (IPS), Observation Social History - Alcohol Use (IPS), Observation Pregnancy - Expected Delivery Date (IPS), Observation Pregnancy - Outcome (IPS), Observation Pregnancy - Status (IPS), Observation Results - Laboratory/Pathology (IPS), Observation Results - Radiology (IPS), Observation Social History - Tobacco Use (IPS), Procedure (IPS) and Specimen (IPS)

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

- Key Elements Table
- Differential Table
- Snapshot Table
- Obligations
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CodeableConcept |  | 0..* | CodeableConcept | Concept - reference to a terminology or just text
coding | SO Σ | 0..* | CodingIPS | Code defined by a terminology system
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
text | SO Σ | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:translation |  | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
CodeableConcept |  |
coding | SHALL:populate-if-known | SHALL:handle
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
Slices for extension |  |
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Description | Expression
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 Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CodeableConcept |  |  | CodeableConcept |
coding | SO | 0..* | CodingIPS | Code defined by a terminology system
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
text | SO | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:translation |  | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
CodeableConcept |  |
coding | SHALL:populate-if-known | SHALL:handle
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
Slices for extension |  |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CodeableConcept |  | 0..* | CodeableConcept | Concept - reference to a terminology or just text
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | SO Σ | 0..* | CodingIPS | Code defined by a terminology system
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
text | SO Σ | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:translation |  | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
value |  | 0..1 | string | Primitive value for string Max Length:1048576
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
CodeableConcept |  |
coding | SHALL:populate-if-known | SHALL:handle
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
Slices for extension |  |
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Description | Expression
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 | Creator (IPS) | Consumer (IPS)
--- | --- | ---
CodeableConcept |  |
coding | SHALL:populate-if-known | SHALL:handle
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
Slices for extension |  |
Documentation for this format

Summary

Must-Support: 2 elements

Structures

This structure refers to these other structures:

- Coding with translations (http://hl7.org/fhir/uv/ips/StructureDefinition/Coding-uv-ips)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

Maturity: 3

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CodeableConcept |  | 0..* | CodeableConcept | Concept - reference to a terminology or just text
coding | SO Σ | 0..* | CodingIPS | Code defined by a terminology system
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
text | SO Σ | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:translation |  | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
CodeableConcept |  |
coding | SHALL:populate-if-known | SHALL:handle
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
Slices for extension |  |
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Description | Expression
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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CodeableConcept |  |  | CodeableConcept |
coding | SO | 0..* | CodingIPS | Code defined by a terminology system
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
text | SO | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:translation |  | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
CodeableConcept |  |
coding | SHALL:populate-if-known | SHALL:handle
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
Slices for extension |  |
Documentation for this format

Snapshot ViewView

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CodeableConcept |  | 0..* | CodeableConcept | Concept - reference to a terminology or just text
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | SO Σ | 0..* | CodingIPS | Code defined by a terminology system
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
text | SO Σ | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:translation |  | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
value |  | 0..1 | string | Primitive value for string Max Length:1048576
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
CodeableConcept |  |
coding | SHALL:populate-if-known | SHALL:handle
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
Slices for extension |  |
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Description | Expression
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 | Creator (IPS) | Consumer (IPS)
--- | --- | ---
CodeableConcept |  |
coding | SHALL:populate-if-known | SHALL:handle
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
Slices for extension |  |
Documentation for this format

Summary

Must-Support: 2 elements

Structures

This structure refers to these other structures:

- Coding with translations (http://hl7.org/fhir/uv/ips/StructureDefinition/Coding-uv-ips)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

Maturity: 3

Other representations of profile: CSV, Excel, Schematron