This page is part of the International Patient Summary Implementation Guide (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.1.0. For a full list of available versions, 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.

Usage:

• Use this DataType Constraint: Codeable Concept (IPS)

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Coding

Name	Flags	Card.	Type	Description & Constraints
Coding			Coding
system	S	0..1	uri	Identity of the terminology system
code	S	0..1	code	Symbol in syntax defined by the system
display	S	0..1	string	Representation defined by the system
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Coding		0..*	Coding	A reference to a code defined by a terminology system
system	SΣ	0..1	uri	Identity of the terminology system
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
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
Coding		0..*	Coding	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
system	SΣ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	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
translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
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

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from Coding

Summary

Must-Support: 3 elements

Extensions

This structure refers to these extensions:

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

Maturity: 2

Differential View

This structure is derived from Coding

Name	Flags	Card.	Type	Description & Constraints
Coding			Coding
system	S	0..1	uri	Identity of the terminology system
code	S	0..1	code	Symbol in syntax defined by the system
display	S	0..1	string	Representation defined by the system
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Coding		0..*	Coding	A reference to a code defined by a terminology system
system	SΣ	0..1	uri	Identity of the terminology system
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Coding		0..*	Coding	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
system	SΣ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	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
translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
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

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from Coding

Summary

Must-Support: 3 elements

Extensions

This structure refers to these extensions:

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

Maturity: 2

Other representations of profile: CSV, Excel, Schematron