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.1 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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Data Type Profile: Coding with translations

This profile extends the capabilities of the coding data type to support multi-language designations (display). It relies on the Translation extension.

Usages:

• Use this DataType Profile: Codeable Concept (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
Coding		0..*	Coding(4.0.1)	A reference to a code defined by a terminology system
system	SOΣ	0..1	uri	Identity of the terminology system Obligations Actor SHALL:populate-if-known Creator (IPS) SHALL:handle Consumer (IPS)
code	SOΣ	0..1	code	Symbol in syntax defined by the system Obligations Actor SHALL:populate-if-known Creator (IPS) SHALL:handle Consumer (IPS)
display	Σ	0..1	string	Text representation defined by the system
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation Constraints: ext-1
Documentation for this format

Name	Consumer (IPS)	Creator (IPS)
Coding
system	SHALL:handle	SHALL:populate-if-known
code	SHALL:handle	SHALL:populate-if-known
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	Coding, Coding.system, Coding.code, Coding.display, Coding.display.extension, Coding.display.extension:translation	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Coding.display.extension, Coding.display.extension:translation	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Coding			Coding(4.0.1)
system	SO	0..1	uri	Identity of the terminology system Obligations Actor SHALL:populate-if-known Creator (IPS) SHALL:handle Consumer (IPS)
code	SO	0..1	code	Symbol in syntax defined by the system Obligations Actor SHALL:populate-if-known Creator (IPS) SHALL:handle Consumer (IPS)
display		0..1	string	Text representation defined by the system
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	Consumer (IPS)	Creator (IPS)
Coding
system	SHALL:handle	SHALL:populate-if-known
code	SHALL:handle	SHALL:populate-if-known
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Coding		0..*	Coding(4.0.1)	A reference to a code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
system	SOΣ	0..1	uri	Identity of the terminology system Obligations Actor SHALL:populate-if-known Creator (IPS) SHALL:handle Consumer (IPS)
version	Σ	0..1	string	Version of the system - if relevant
code	SOΣ	0..1	code	Symbol in syntax defined by the system Obligations Actor SHALL:populate-if-known Creator (IPS) SHALL:handle Consumer (IPS)
display	Σ	0..1	string	Text representation defined by the system
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation Constraints: ext-1
value		0..1	string	Primitive value for string Max Length:1048576
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
Documentation for this format

Name	Consumer (IPS)	Creator (IPS)
Coding
system	SHALL:handle	SHALL:populate-if-known
code	SHALL:handle	SHALL:populate-if-known
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	Coding, Coding.extension, Coding.system, Coding.version, Coding.code, Coding.display, Coding.display.extension, Coding.display.extension:translation, Coding.userSelected	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Coding.extension, Coding.display.extension, Coding.display.extension:translation	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Name	Consumer (IPS)	Creator (IPS)
Coding
system	SHALL:handle	SHALL:populate-if-known
code	SHALL:handle	SHALL:populate-if-known
Documentation for this format

Summary

Must-Support: 2 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/translation|5.3.0

Maturity: 3

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Coding		0..*	Coding(4.0.1)	A reference to a code defined by a terminology system
system	SOΣ	0..1	uri	Identity of the terminology system Obligations Actor SHALL:populate-if-known Creator (IPS) SHALL:handle Consumer (IPS)
code	SOΣ	0..1	code	Symbol in syntax defined by the system Obligations Actor SHALL:populate-if-known Creator (IPS) SHALL:handle Consumer (IPS)
display	Σ	0..1	string	Text representation defined by the system
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation Constraints: ext-1
Documentation for this format

Name	Consumer (IPS)	Creator (IPS)
Coding
system	SHALL:handle	SHALL:populate-if-known
code	SHALL:handle	SHALL:populate-if-known
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	Coding, Coding.system, Coding.code, Coding.display, Coding.display.extension, Coding.display.extension:translation	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Coding.display.extension, Coding.display.extension:translation	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
Coding			Coding(4.0.1)
system	SO	0..1	uri	Identity of the terminology system Obligations Actor SHALL:populate-if-known Creator (IPS) SHALL:handle Consumer (IPS)
code	SO	0..1	code	Symbol in syntax defined by the system Obligations Actor SHALL:populate-if-known Creator (IPS) SHALL:handle Consumer (IPS)
display		0..1	string	Text representation defined by the system
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	Consumer (IPS)	Creator (IPS)
Coding
system	SHALL:handle	SHALL:populate-if-known
code	SHALL:handle	SHALL:populate-if-known
Documentation for this format

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Coding		0..*	Coding(4.0.1)	A reference to a code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
system	SOΣ	0..1	uri	Identity of the terminology system Obligations Actor SHALL:populate-if-known Creator (IPS) SHALL:handle Consumer (IPS)
version	Σ	0..1	string	Version of the system - if relevant
code	SOΣ	0..1	code	Symbol in syntax defined by the system Obligations Actor SHALL:populate-if-known Creator (IPS) SHALL:handle Consumer (IPS)
display	Σ	0..1	string	Text representation defined by the system
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation Constraints: ext-1
value		0..1	string	Primitive value for string Max Length:1048576
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
Documentation for this format

Name	Consumer (IPS)	Creator (IPS)
Coding
system	SHALL:handle	SHALL:populate-if-known
code	SHALL:handle	SHALL:populate-if-known
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	Coding, Coding.extension, Coding.system, Coding.version, Coding.code, Coding.display, Coding.display.extension, Coding.display.extension:translation, Coding.userSelected	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Coding.extension, Coding.display.extension, Coding.display.extension:translation	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Name	Consumer (IPS)	Creator (IPS)
Coding
system	SHALL:handle	SHALL:populate-if-known
code	SHALL:handle	SHALL:populate-if-known
Documentation for this format

Summary

Must-Support: 2 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/translation|5.3.0

Maturity: 3

Other representations of profile: CSV, Excel, Schematron