Finnish Scheduling, published by HL7 Finland. This guide is not an authorized publication; it is the continuous build for version 0.2.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/fhir-fi/finnish-scheduling/ and changes regularly. See the Directory of published versions

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

Resource Profile: FinnishAppointmentPatient

Resource profile for patient to be used in Finnish social and healthcare setting. Supports official and temporary national ids. Supports home municipality extension.

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

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 Patient

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
homeMunicipality		0..*	Coding	Extension URL: http://hl7.fi/fhir/StructureDefinition/HomeMunicipalityExtension
Slices for identifier		0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:use
identifier:sliceIdentifierOfficial		0..*	Identifier	An identifier for this patient Fixed Value: As shown
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.246.21
value		1..1	string	The value that is unique
identifier:sliceIdentifierTemp		0..*	Identifier	An identifier for this patient Fixed Value: As shown
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: temp
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: temp
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
contact
relationship
coding
system		0..1	uri	Identity of the terminology system Fixed Value: urn:oid:1.2.246.537.6.882
communication
language
coding
system		0..1	uri	Identity of the terminology system Fixed Value: urn:oid:1.2.246.537.5.40175.2008
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
homeMunicipality		0..*	Coding	Extension URL: http://hl7.fi/fhir/StructureDefinition/HomeMunicipalityExtension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:use
identifier:sliceIdentifierOfficial	Σ	0..*	Identifier	An identifier for this patient Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
type		0..0	CodeableConcept	Description of identifier
system		0..0	uri	The namespace for the identifier value
value		0..0	string	The value that is unique
period		0..0	Period	Time period when id is/was valid for use
assigner		0..0	Reference(Organization)	Organization that issued id (may be just text)
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.246.21
value	Σ	1..1	string	The value that is unique Example General: 123456
identifier:sliceIdentifierTemp	Σ	0..*	Identifier	An identifier for this patient Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: temp
type		0..0	CodeableConcept	Description of identifier
system		0..0	uri	The namespace for the identifier value
value		0..0	string	The value that is unique
period		0..0	Period	Time period when id is/was valid for use
assigner		0..0	Reference(Organization)	Organization that issued id (may be just text)
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: temp
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.identifier:sliceIdentifierOfficial.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:sliceIdentifierTemp.use	required	Fixed Value: temp http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
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
Patient		0..*	Patient	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
homeMunicipality		0..*	Coding	Extension URL: http://hl7.fi/fhir/StructureDefinition/HomeMunicipalityExtension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:use
identifier:sliceIdentifierOfficial	Σ	0..*	Identifier	An identifier for this patient Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
type		0..0	CodeableConcept	Description of identifier
system		0..0	uri	The namespace for the identifier value
value		0..0	string	The value that is unique
period		0..0	Period	Time period when id is/was valid for use
assigner		0..0	Reference(Organization)	Organization that issued id (may be 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
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
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	Σ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.246.21
value	Σ	1..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)
identifier:sliceIdentifierTemp	Σ	0..*	Identifier	An identifier for this patient Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: temp
type		0..0	CodeableConcept	Description of identifier
system		0..0	uri	The namespace for the identifier value
value		0..0	string	The value that is unique
period		0..0	Period	Time period when id is/was valid for use
assigner		0..0	Reference(Organization)	Organization that issued id (may be 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
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: temp
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	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..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)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	0..*	HumanName	A name associated with the patient
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..*	Address	An address for the individual
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
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	Σ	0..*	Coding	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	Σ	0..1	uri	Identity of the terminology system Fixed Value: urn:oid:1.2.246.537.6.882
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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	Σ	0..*	Coding	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	Σ	0..1	uri	Identity of the terminology system Fixed Value: urn:oid:1.2.246.537.5.40175.2008
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.identifier:sliceIdentifierOfficial.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:sliceIdentifierOfficial.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:sliceIdentifierTemp.use	required	Fixed Value: temp http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:sliceIdentifierTemp.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
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()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Patient

Summary

Mandatory: 0 element(6 nested mandatory elements)
Fixed: 7 elements

Extensions

This structure refers to these extensions:

• http://hl7.fi/fhir/StructureDefinition/HomeMunicipalityExtension

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier

Differential View

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
homeMunicipality		0..*	Coding	Extension URL: http://hl7.fi/fhir/StructureDefinition/HomeMunicipalityExtension
Slices for identifier		0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:use
identifier:sliceIdentifierOfficial		0..*	Identifier	An identifier for this patient Fixed Value: As shown
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.246.21
value		1..1	string	The value that is unique
identifier:sliceIdentifierTemp		0..*	Identifier	An identifier for this patient Fixed Value: As shown
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: temp
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: temp
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
contact
relationship
coding
system		0..1	uri	Identity of the terminology system Fixed Value: urn:oid:1.2.246.537.6.882
communication
language
coding
system		0..1	uri	Identity of the terminology system Fixed Value: urn:oid:1.2.246.537.5.40175.2008
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
homeMunicipality		0..*	Coding	Extension URL: http://hl7.fi/fhir/StructureDefinition/HomeMunicipalityExtension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:use
identifier:sliceIdentifierOfficial	Σ	0..*	Identifier	An identifier for this patient Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
type		0..0	CodeableConcept	Description of identifier
system		0..0	uri	The namespace for the identifier value
value		0..0	string	The value that is unique
period		0..0	Period	Time period when id is/was valid for use
assigner		0..0	Reference(Organization)	Organization that issued id (may be just text)
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.246.21
value	Σ	1..1	string	The value that is unique Example General: 123456
identifier:sliceIdentifierTemp	Σ	0..*	Identifier	An identifier for this patient Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: temp
type		0..0	CodeableConcept	Description of identifier
system		0..0	uri	The namespace for the identifier value
value		0..0	string	The value that is unique
period		0..0	Period	Time period when id is/was valid for use
assigner		0..0	Reference(Organization)	Organization that issued id (may be just text)
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: temp
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.identifier:sliceIdentifierOfficial.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:sliceIdentifierTemp.use	required	Fixed Value: temp http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
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
Patient		0..*	Patient	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
homeMunicipality		0..*	Coding	Extension URL: http://hl7.fi/fhir/StructureDefinition/HomeMunicipalityExtension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:use
identifier:sliceIdentifierOfficial	Σ	0..*	Identifier	An identifier for this patient Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
type		0..0	CodeableConcept	Description of identifier
system		0..0	uri	The namespace for the identifier value
value		0..0	string	The value that is unique
period		0..0	Period	Time period when id is/was valid for use
assigner		0..0	Reference(Organization)	Organization that issued id (may be 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
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
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	Σ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.246.21
value	Σ	1..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)
identifier:sliceIdentifierTemp	Σ	0..*	Identifier	An identifier for this patient Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: temp
type		0..0	CodeableConcept	Description of identifier
system		0..0	uri	The namespace for the identifier value
value		0..0	string	The value that is unique
period		0..0	Period	Time period when id is/was valid for use
assigner		0..0	Reference(Organization)	Organization that issued id (may be 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
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: temp
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	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..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)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	0..*	HumanName	A name associated with the patient
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..*	Address	An address for the individual
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
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	Σ	0..*	Coding	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	Σ	0..1	uri	Identity of the terminology system Fixed Value: urn:oid:1.2.246.537.6.882
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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	Σ	0..*	Coding	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	Σ	0..1	uri	Identity of the terminology system Fixed Value: urn:oid:1.2.246.537.5.40175.2008
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.identifier:sliceIdentifierOfficial.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:sliceIdentifierOfficial.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:sliceIdentifierTemp.use	required	Fixed Value: temp http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:sliceIdentifierTemp.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
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()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Patient

Summary

Mandatory: 0 element(6 nested mandatory elements)
Fixed: 7 elements

Extensions

This structure refers to these extensions:

• http://hl7.fi/fhir/StructureDefinition/HomeMunicipalityExtension

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier

Other representations of profile: CSV, Excel, Schematron