MyHealth@Eu Laboratory Report - Local Development build (v0.0.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: Patient: Laboratory

This profile defines how to represent Patients in HL7 FHIR for the purpose of this guide.

Usage:

• Use this Resource Profile: Bundle: Laboratory
• Refer to this Resource Profile: Composition: Laboratory, DiagnosticReport: Laboratory, Observation Results: Laboratory, ServiceRequest: Laboratory and Specimen: Laboratory
• Examples for this Resource Profile: Patient/SamplePatient

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
Patient		0..*	Patient	Information about an individual or animal receiving health care services This profile also imposes the profile Patient: Person dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
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
sex-for-clinical-use	O	0..*	(Complex)	A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Obligations Actor SHALL:handle LabReportHandler
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	OΣ	0..*	Identifier	An identifier for this patient. ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle LabReportHandler
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
name	Σ	0..*	HumanNameEu	A name associated with the patient ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Textual full name ele-1: All FHIR elements must have a @value or children
family	OΣ	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children Example spanish name: Valero Iglesias Obligations Actor SHALL:handle LabReportHandler
Slices for extension				Content/Rules for all slices
fathersFamily		0..*	string	Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Example spanish name: Valero
mothersFamily		0..*	string	Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Example spanish name: Iglesias
given	OΣ	1..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name Example spanish name: Borja Obligations Actor SHALL:handle LabReportHandler
telecom	OΣ	0..*	ContactPoint	A contact detail for the patient ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle LabReportHandler
gender	OΣ	0..1	code	Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle LabReportHandler
birthDate	OΣ	1..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle LabReportHandler
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	OΣ	0..*	AddressEu	An address for the individual ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle LabReportHandler
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
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
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-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()

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints
Patient			Patient	This profile also imposes the profile Patient: Person
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
sex-for-clinical-use	O	0..*	(Complex)	A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse Obligations Actor SHALL:handle LabReportHandler
identifier	O	0..*	Identifier	An identifier for this patient. Obligations Actor SHALL:handle LabReportHandler
name		0..*	HumanNameEu	A name associated with the patient
text		0..1	string	Textual full name
family	O	1..1	string	Family name (often called 'Surname') Obligations Actor SHALL:handle LabReportHandler
given	O	1..*	string	Given names (not always 'first'). Includes middle names Obligations Actor SHALL:handle LabReportHandler
telecom	O	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:handle LabReportHandler
gender	O	0..1	code	Administrative gender Obligations Actor SHALL:handle LabReportHandler
birthDate	O	1..1	date	The date of birth for the individual Obligations Actor SHALL:handle LabReportHandler
address	O	0..*	AddressEu	An address for the individual Obligations Actor SHALL:handle LabReportHandler
country
Slices for extension				Content/Rules for all slices
extension:countryCode	O	0..1	SCCoding(5.2.0)	code for string Obligations Actor SHALL:handle LabReportHandler
value[x]		1..1	Coding	Value of extension Binding: eHDSI Country (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.address.country.extension:countryCode.value[x]	required	EHDSICountry http://terminology.ehdsi.eu/ValueSet/eHDSICountry from this IG

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services This profile also imposes the profile Patient: Person
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
sex-for-clinical-use	O	0..*	(Complex)	A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse Obligations Actor SHALL:handle LabReportHandler
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	OΣ	0..*	Identifier	An identifier for this patient. Obligations Actor SHALL:handle LabReportHandler
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	0..*	HumanNameEu	A name associated with the 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
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Textual full name
family	OΣ	1..1	string	Family name (often called 'Surname') Example spanish name: Valero Iglesias Obligations Actor SHALL:handle LabReportHandler
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
fathersFamily		0..*	string	Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family Example spanish name: Valero
mothersFamily		0..*	string	Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family Example spanish name: Iglesias
value		0..1	string	Primitive value for string Max Length:1048576
given	OΣ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Example spanish name: Borja Obligations Actor SHALL:handle LabReportHandler
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	OΣ	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:handle LabReportHandler
gender	OΣ	0..1	code	Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:handle LabReportHandler
birthDate	OΣ	1..1	date	The date of birth for the individual Obligations Actor SHALL:handle LabReportHandler
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	OΣ	0..*	AddressEu	An address for the individual Obligations Actor SHALL:handle LabReportHandler
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	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
streetName		0..*	string	streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
houseNumber		0..*	string	houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
postBox		0..*	string	postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
value		0..1	string	Primitive value for string Max Length:1048576
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
countryCode	O	0..1	(Complex)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Obligations Actor SHALL:handle LabReportHandler
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding"
value[x]		1..1	Coding	Value of extension Binding: eHDSI Country (required)
value		0..1	string	Primitive value for string Max Length:1048576
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
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.
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
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	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address.country.extension:countryCode.value[x]	required	EHDSICountry http://terminology.ehdsi.eu/ValueSet/eHDSICountry from this IG
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 http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
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: 1 element(2 nested mandatory elements)

Structures

This structure refers to these other structures:

• HumanName (Eu) (http://hl7.eu/fhir/laboratory/StructureDefinition/HumanName-eu)
• Address (EU) (http://hl7.eu/fhir/laboratory/StructureDefinition/Address-eu)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services This profile also imposes the profile Patient: Person dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
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
sex-for-clinical-use	O	0..*	(Complex)	A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Obligations Actor SHALL:handle LabReportHandler
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	OΣ	0..*	Identifier	An identifier for this patient. ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle LabReportHandler
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
name	Σ	0..*	HumanNameEu	A name associated with the patient ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Textual full name ele-1: All FHIR elements must have a @value or children
family	OΣ	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children Example spanish name: Valero Iglesias Obligations Actor SHALL:handle LabReportHandler
Slices for extension				Content/Rules for all slices
fathersFamily		0..*	string	Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Example spanish name: Valero
mothersFamily		0..*	string	Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Example spanish name: Iglesias
given	OΣ	1..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name Example spanish name: Borja Obligations Actor SHALL:handle LabReportHandler
telecom	OΣ	0..*	ContactPoint	A contact detail for the patient ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle LabReportHandler
gender	OΣ	0..1	code	Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle LabReportHandler
birthDate	OΣ	1..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle LabReportHandler
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	OΣ	0..*	AddressEu	An address for the individual ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle LabReportHandler
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
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
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-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()

Differential View

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints
Patient			Patient	This profile also imposes the profile Patient: Person
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
sex-for-clinical-use	O	0..*	(Complex)	A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse Obligations Actor SHALL:handle LabReportHandler
identifier	O	0..*	Identifier	An identifier for this patient. Obligations Actor SHALL:handle LabReportHandler
name		0..*	HumanNameEu	A name associated with the patient
text		0..1	string	Textual full name
family	O	1..1	string	Family name (often called 'Surname') Obligations Actor SHALL:handle LabReportHandler
given	O	1..*	string	Given names (not always 'first'). Includes middle names Obligations Actor SHALL:handle LabReportHandler
telecom	O	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:handle LabReportHandler
gender	O	0..1	code	Administrative gender Obligations Actor SHALL:handle LabReportHandler
birthDate	O	1..1	date	The date of birth for the individual Obligations Actor SHALL:handle LabReportHandler
address	O	0..*	AddressEu	An address for the individual Obligations Actor SHALL:handle LabReportHandler
country
Slices for extension				Content/Rules for all slices
extension:countryCode	O	0..1	SCCoding(5.2.0)	code for string Obligations Actor SHALL:handle LabReportHandler
value[x]		1..1	Coding	Value of extension Binding: eHDSI Country (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.address.country.extension:countryCode.value[x]	required	EHDSICountry http://terminology.ehdsi.eu/ValueSet/eHDSICountry from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services This profile also imposes the profile Patient: Person
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
sex-for-clinical-use	O	0..*	(Complex)	A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse Obligations Actor SHALL:handle LabReportHandler
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	OΣ	0..*	Identifier	An identifier for this patient. Obligations Actor SHALL:handle LabReportHandler
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	0..*	HumanNameEu	A name associated with the 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
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Textual full name
family	OΣ	1..1	string	Family name (often called 'Surname') Example spanish name: Valero Iglesias Obligations Actor SHALL:handle LabReportHandler
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
fathersFamily		0..*	string	Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family Example spanish name: Valero
mothersFamily		0..*	string	Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family Example spanish name: Iglesias
value		0..1	string	Primitive value for string Max Length:1048576
given	OΣ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Example spanish name: Borja Obligations Actor SHALL:handle LabReportHandler
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	OΣ	0..*	ContactPoint	A contact detail for the patient Obligations Actor SHALL:handle LabReportHandler
gender	OΣ	0..1	code	Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:handle LabReportHandler
birthDate	OΣ	1..1	date	The date of birth for the individual Obligations Actor SHALL:handle LabReportHandler
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	OΣ	0..*	AddressEu	An address for the individual Obligations Actor SHALL:handle LabReportHandler
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	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
streetName		0..*	string	streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
houseNumber		0..*	string	houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
postBox		0..*	string	postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
value		0..1	string	Primitive value for string Max Length:1048576
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
countryCode	O	0..1	(Complex)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Obligations Actor SHALL:handle LabReportHandler
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding"
value[x]		1..1	Coding	Value of extension Binding: eHDSI Country (required)
value		0..1	string	Primitive value for string Max Length:1048576
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
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.
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
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	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address.country.extension:countryCode.value[x]	required	EHDSICountry http://terminology.ehdsi.eu/ValueSet/eHDSICountry from this IG
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 http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
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: 1 element(2 nested mandatory elements)

Structures

This structure refers to these other structures:

• HumanName (Eu) (http://hl7.eu/fhir/laboratory/StructureDefinition/HumanName-eu)
• Address (EU) (http://hl7.eu/fhir/laboratory/StructureDefinition/Address-eu)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse

Other representations of profile: CSV, Excel, Schematron