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/costateixeira/fhir-ips/ and changes regularly. See the Directory of published versions

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

Logical Model: Patient

Patient

Usage:

• Use this Logical Model Profile: ISO 27269 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
PatientFeature		0..*	Base	Patient Instances of this logical model can be the target of a Reference
name		1..1	MName	Name
address		0..*	BackboneElement	Address ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Address		0..*	MAddress	Address
Telecom		0..*	MTelecom	Telecom
administrativeGender		0..1	CodeableConcept	Administrative Gender
dateOfBirth		0..1	date	Date of Birth
preferredLanguage		0..1	CodeableConcept	Patient's preferred Language
healthcareRelatedIdentifiers		0..*	Identifier	Healthcare related identifiers ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations 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
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children
system	Σ	0..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children
patientIdentifier		0..*	Identifier	Patient Identifier
insuranceInformation		0..*	BackboneElement	Insurance Information ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
insuranceProvider		0..*	Identifier	Insurance identifier
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PatientFeature.healthcareRelatedIdentifiers.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PatientFeature.healthcareRelatedIdentifiers.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard

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 Base

Name	Flags	Card.	Type	Description & Constraints
PatientFeature		0..*	Base	Patient Instances of this logical model can be the target of a Reference
name		1..1	MName	Name
address		0..*	BackboneElement	Address
Address		0..*	MAddress	Address
Telecom		0..*	MTelecom	Telecom
administrativeGender		0..1	CodeableConcept	Administrative Gender
dateOfBirth		0..1	date	Date of Birth
preferredLanguage		0..1	CodeableConcept	Patient's preferred Language
healthcareRelatedIdentifiers		0..*	Identifier	Healthcare related identifiers
patientIdentifier		0..*	Identifier	Patient Identifier
insuranceInformation		0..*	BackboneElement	Insurance Information
insuranceProvider		0..*	Identifier	Insurance identifier
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
PatientFeature		0..*	Base	Patient Instances of this logical model can be the target of a Reference
name		1..1	MName	Name
address		0..*	BackboneElement	Address
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Address		0..*	MAddress	Address
Telecom		0..*	MTelecom	Telecom
administrativeGender		0..1	CodeableConcept	Administrative Gender
dateOfBirth		0..1	date	Date of Birth
preferredLanguage		0..1	CodeableConcept	Patient's preferred Language
healthcareRelatedIdentifiers		0..*	Identifier	Healthcare related identifiers
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
patientIdentifier		0..*	Identifier	Patient Identifier
insuranceInformation		0..*	BackboneElement	Insurance Information
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
insuranceProvider		0..*	Identifier	Insurance identifier
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PatientFeature.healthcareRelatedIdentifiers.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PatientFeature.healthcareRelatedIdentifiers.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard

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 Base

Summary

Mandatory: 0 element(1 nested mandatory element)

Maturity: 2

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
PatientFeature		0..*	Base	Patient Instances of this logical model can be the target of a Reference
name		1..1	MName	Name
address		0..*	BackboneElement	Address ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Address		0..*	MAddress	Address
Telecom		0..*	MTelecom	Telecom
administrativeGender		0..1	CodeableConcept	Administrative Gender
dateOfBirth		0..1	date	Date of Birth
preferredLanguage		0..1	CodeableConcept	Patient's preferred Language
healthcareRelatedIdentifiers		0..*	Identifier	Healthcare related identifiers ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations 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
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children
system	Σ	0..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children
patientIdentifier		0..*	Identifier	Patient Identifier
insuranceInformation		0..*	BackboneElement	Insurance Information ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
insuranceProvider		0..*	Identifier	Insurance identifier
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PatientFeature.healthcareRelatedIdentifiers.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PatientFeature.healthcareRelatedIdentifiers.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard

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 Base

Name	Flags	Card.	Type	Description & Constraints
PatientFeature		0..*	Base	Patient Instances of this logical model can be the target of a Reference
name		1..1	MName	Name
address		0..*	BackboneElement	Address
Address		0..*	MAddress	Address
Telecom		0..*	MTelecom	Telecom
administrativeGender		0..1	CodeableConcept	Administrative Gender
dateOfBirth		0..1	date	Date of Birth
preferredLanguage		0..1	CodeableConcept	Patient's preferred Language
healthcareRelatedIdentifiers		0..*	Identifier	Healthcare related identifiers
patientIdentifier		0..*	Identifier	Patient Identifier
insuranceInformation		0..*	BackboneElement	Insurance Information
insuranceProvider		0..*	Identifier	Insurance identifier
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
PatientFeature		0..*	Base	Patient Instances of this logical model can be the target of a Reference
name		1..1	MName	Name
address		0..*	BackboneElement	Address
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Address		0..*	MAddress	Address
Telecom		0..*	MTelecom	Telecom
administrativeGender		0..1	CodeableConcept	Administrative Gender
dateOfBirth		0..1	date	Date of Birth
preferredLanguage		0..1	CodeableConcept	Patient's preferred Language
healthcareRelatedIdentifiers		0..*	Identifier	Healthcare related identifiers
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
patientIdentifier		0..*	Identifier	Patient Identifier
insuranceInformation		0..*	BackboneElement	Insurance Information
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
insuranceProvider		0..*	Identifier	Insurance identifier
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PatientFeature.healthcareRelatedIdentifiers.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PatientFeature.healthcareRelatedIdentifiers.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard

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 Base

Summary

Mandatory: 0 element(1 nested mandatory element)

Maturity: 2

Other representations of profile: CSV, Excel