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

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

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

Name	Flags	Card.	Type	Description & Constraints
Coding		0..*	Coding	A reference to a code defined by a terminology system ele-1: All FHIR elements must have a @value or children
system	SOΣ	0..1	uri	Identity of the terminology system ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known Producer (IPS) SHALL:handle Consumer (IPS)
code	SOΣ	0..1	code	Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known Producer (IPS) SHALL:handle Consumer (IPS)
display	SOΣ	0..1	string	Representation defined by the system ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known Producer (IPS) SHALL:handle Consumer (IPS) SHOULD:display Consumer (IPS)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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

Name	Flags	Card.	Type	Description & Constraints
Coding			Coding
system	SO	0..1	uri	Identity of the terminology system Obligations Actor SHALL:populate-if-known Producer (IPS) SHALL:handle Consumer (IPS)
code	SO	0..1	code	Symbol in syntax defined by the system Obligations Actor SHALL:populate-if-known Producer (IPS) SHALL:handle Consumer (IPS)
display	SO	0..1	string	Representation defined by the system Obligations Actor SHALL:populate-if-known Producer (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	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	SOΣ	0..1	uri	Identity of the terminology system Obligations Actor SHALL:populate-if-known Producer (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 Producer (IPS) SHALL:handle Consumer (IPS)
display	SOΣ	0..1	string	Representation defined by the system Obligations Actor SHALL:populate-if-known Producer (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
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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Coding		0..*	Coding	A reference to a code defined by a terminology system ele-1: All FHIR elements must have a @value or children
system	SOΣ	0..1	uri	Identity of the terminology system ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known Producer (IPS) SHALL:handle Consumer (IPS)
code	SOΣ	0..1	code	Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known Producer (IPS) SHALL:handle Consumer (IPS)
display	SOΣ	0..1	string	Representation defined by the system ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known Producer (IPS) SHALL:handle Consumer (IPS) SHOULD:display Consumer (IPS)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:translation		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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()

Differential View

This structure is derived from Coding

Name	Flags	Card.	Type	Description & Constraints
Coding			Coding
system	SO	0..1	uri	Identity of the terminology system Obligations Actor SHALL:populate-if-known Producer (IPS) SHALL:handle Consumer (IPS)
code	SO	0..1	code	Symbol in syntax defined by the system Obligations Actor SHALL:populate-if-known Producer (IPS) SHALL:handle Consumer (IPS)
display	SO	0..1	string	Representation defined by the system Obligations Actor SHALL:populate-if-known Producer (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

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	SOΣ	0..1	uri	Identity of the terminology system Obligations Actor SHALL:populate-if-known Producer (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 Producer (IPS) SHALL:handle Consumer (IPS)
display	SOΣ	0..1	string	Representation defined by the system Obligations Actor SHALL:populate-if-known Producer (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
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