Retention Implementation Guide - Local Development build (v2.0.0) 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 Retention

Patient profile for Retention project

Usages:

• Examples for this Profile: Patient/P001

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    Filter: Bindings Constraints Obligations
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
extension:sex		0..1	(Complex)	Patient Sex URL: https://www.retention-project.eu/ig/StructureDefinition/PatientSex
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientSex"
extension:patientEthnicity		0..1	(Complex)	Patient Ethnicity URL: https://www.retention-project.eu/ig/StructureDefinition/PatientEthnicity
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientEthnicity"
extension:countryOfResidence		0..1	(Complex)	Patient Country of residence URL: https://www.retention-project.eu/ig/StructureDefinition/PatientCountryOfResidence
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientCountryOfResidence"
extension:maritalStatus		0..1	(Complex)	Patient Marital Status URL: https://www.retention-project.eu/ig/StructureDefinition/PatientMaritalStatus
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientMaritalStatus"
extension:height		0..1	UsageContext	Patient Height URL: https://www.retention-project.eu/ig/StructureDefinition/PatientHeight
extension:aboBloodGroup		0..1	(Complex)	Patient ABO blood group URL: https://www.retention-project.eu/ig/StructureDefinition/PatientAboBloodGroup
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientAboBloodGroup"
extension:highestLevelOfEducation		0..1	(Complex)	Patient Highest level of education URL: https://www.retention-project.eu/ig/StructureDefinition/PatientHighestLevelOfEducation
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientHighestLevelOfEducation"
extension:employmentStatus		0..1	(Complex)	Patient Employment status URL: https://www.retention-project.eu/ig/StructureDefinition/PatientEmploymentStatus
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientEmploymentStatus"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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	URI
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    Filter: Bindings Constraints Obligations
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
extension:sex		0..1	(Complex)	Patient Sex URL: https://www.retention-project.eu/ig/StructureDefinition/PatientSex
value[x]
value[x]
coding
system		0..1	uri	Identity of the terminology system Fixed Value: https://www.retention-project.eu/ig/CodeSystem/Sex
extension:patientEthnicity		0..1	(Complex)	Patient Ethnicity URL: https://www.retention-project.eu/ig/StructureDefinition/PatientEthnicity
value[x]
value[x]
coding
system		0..1	uri	Identity of the terminology system Fixed Value: https://www.retention-project.eu/ig/CodeSystem/Ethnicity
extension:countryOfResidence		0..1	(Complex)	Patient Country of residence URL: https://www.retention-project.eu/ig/StructureDefinition/PatientCountryOfResidence
value[x]
value[x]
coding
system		0..1	uri	Identity of the terminology system Fixed Value: https://www.retention-project.eu/ig/CodeSystem/CountryOfResidence
extension:maritalStatus		0..1	(Complex)	Patient Marital Status URL: https://www.retention-project.eu/ig/StructureDefinition/PatientMaritalStatus
value[x]
value[x]
coding
system		0..1	uri	Identity of the terminology system Fixed Value: https://www.retention-project.eu/ig/CodeSystem/MaritalStatus
extension:height		0..1	UsageContext	Patient Height URL: https://www.retention-project.eu/ig/StructureDefinition/PatientHeight
extension:aboBloodGroup		0..1	(Complex)	Patient ABO blood group URL: https://www.retention-project.eu/ig/StructureDefinition/PatientAboBloodGroup
value[x]
value[x]
coding
system		0..1	uri	Identity of the terminology system Fixed Value: https://www.retention-project.eu/ig/CodeSystem/AboBloodGroup
extension:highestLevelOfEducation		0..1	(Complex)	Patient Highest level of education URL: https://www.retention-project.eu/ig/StructureDefinition/PatientHighestLevelOfEducation
value[x]
value[x]
coding
system		0..1	uri	Identity of the terminology system Fixed Value: https://www.retention-project.eu/ig/CodeSystem/HighestLevelOfEducation
extension:employmentStatus		0..1	(Complex)	Patient Employment status URL: https://www.retention-project.eu/ig/StructureDefinition/PatientEmploymentStatus
value[x]
value[x]
coding
system		0..1	uri	Identity of the terminology system Fixed Value: https://www.retention-project.eu/ig/CodeSystem/EmploymentStatus
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:sex		0..1	(Complex)	Patient Sex URL: https://www.retention-project.eu/ig/StructureDefinition/PatientSex
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientSex"
value[x]		0..1	UsageContext	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
code	Σ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 263495000
display		1..1	string	Representation defined by the system Fixed Value: Gender
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	Σ	1..1	CodeableConcept	Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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: https://www.retention-project.eu/ig/CodeSystem/Sex
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
extension:patientEthnicity		0..1	(Complex)	Patient Ethnicity URL: https://www.retention-project.eu/ig/StructureDefinition/PatientEthnicity
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientEthnicity"
value[x]		0..1	UsageContext	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
code	Σ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 397731000
display		1..1	string	Representation defined by the system Fixed Value: Ethnic group finding
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	Σ	1..1	CodeableConcept	Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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: https://www.retention-project.eu/ig/CodeSystem/Ethnicity
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
extension:countryOfResidence		0..1	(Complex)	Patient Country of residence URL: https://www.retention-project.eu/ig/StructureDefinition/PatientCountryOfResidence
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientCountryOfResidence"
value[x]		0..1	UsageContext	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
code	Σ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 416647007
display		1..1	string	Representation defined by the system Fixed Value: Country of residence
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	Σ	1..1	CodeableConcept	Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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: https://www.retention-project.eu/ig/CodeSystem/CountryOfResidence
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
extension:maritalStatus		0..1	(Complex)	Patient Marital Status URL: https://www.retention-project.eu/ig/StructureDefinition/PatientMaritalStatus
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientMaritalStatus"
value[x]		0..1	UsageContext	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
code	Σ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 125680007
display		1..1	string	Representation defined by the system Fixed Value: Marital status
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	Σ	1..1	CodeableConcept	Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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: https://www.retention-project.eu/ig/CodeSystem/MaritalStatus
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
extension:height		0..1	UsageContext	Patient Height URL: https://www.retention-project.eu/ig/StructureDefinition/PatientHeight
extension:aboBloodGroup		0..1	(Complex)	Patient ABO blood group URL: https://www.retention-project.eu/ig/StructureDefinition/PatientAboBloodGroup
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientAboBloodGroup"
value[x]		0..1	UsageContext	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
code	Σ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 365637002
display		1..1	string	Representation defined by the system Fixed Value: Finding of ABO blood group
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	Σ	1..1	CodeableConcept	Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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: https://www.retention-project.eu/ig/CodeSystem/AboBloodGroup
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
extension:highestLevelOfEducation		0..1	(Complex)	Patient Highest level of education URL: https://www.retention-project.eu/ig/StructureDefinition/PatientHighestLevelOfEducation
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientHighestLevelOfEducation"
value[x]		0..1	UsageContext	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
code	Σ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 105421008
display		1..1	string	Representation defined by the system Fixed Value: Educational achievement
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	Σ	1..1	CodeableConcept	Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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: https://www.retention-project.eu/ig/CodeSystem/HighestLevelOfEducation
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
extension:employmentStatus		0..1	(Complex)	Patient Employment status URL: https://www.retention-project.eu/ig/StructureDefinition/PatientEmploymentStatus
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientEmploymentStatus"
value[x]		0..1	UsageContext	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
code	Σ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 224362002
display		1..1	string	Representation defined by the system Fixed Value: Employment status
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	Σ	1..1	CodeableConcept	Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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: https://www.retention-project.eu/ig/CodeSystem/EmploymentStatus
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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	An identifier for this patient
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 Constraints: pat-1
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 / Code	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.extension:sex.value[x].code	extensible	Pattern Value: SNOMED-CT Code 263495000("Gender") http://hl7.org/fhir/ValueSet/usage-context-type From the FHIR Standard
Patient.extension:sex.value[x].value[x]	example	Context of Use ValueSet http://hl7.org/fhir/ValueSet/use-context From the FHIR Standard
Patient.extension:patientEthnicity.value[x].code	extensible	Pattern Value: SNOMED-CT Code 397731000("Ethnic group finding") http://hl7.org/fhir/ValueSet/usage-context-type From the FHIR Standard
Patient.extension:patientEthnicity.value[x].value[x]	example	Context of Use ValueSet http://hl7.org/fhir/ValueSet/use-context From the FHIR Standard
Patient.extension:countryOfResidence.value[x].code	extensible	Pattern Value: SNOMED-CT Code 416647007("Country of residence") http://hl7.org/fhir/ValueSet/usage-context-type From the FHIR Standard
Patient.extension:countryOfResidence.value[x].value[x]	example	Context of Use ValueSet http://hl7.org/fhir/ValueSet/use-context From the FHIR Standard
Patient.extension:maritalStatus.value[x].code	extensible	Pattern Value: SNOMED-CT Code 125680007("Marital status") http://hl7.org/fhir/ValueSet/usage-context-type From the FHIR Standard
Patient.extension:maritalStatus.value[x].value[x]	example	Context of Use ValueSet http://hl7.org/fhir/ValueSet/use-context From the FHIR Standard
Patient.extension:aboBloodGroup.value[x].code	extensible	Pattern Value: SNOMED-CT Code 365637002("Finding of ABO blood group") http://hl7.org/fhir/ValueSet/usage-context-type From the FHIR Standard
Patient.extension:aboBloodGroup.value[x].value[x]	example	Context of Use ValueSet http://hl7.org/fhir/ValueSet/use-context From the FHIR Standard
Patient.extension:highestLevelOfEducation.value[x].code	extensible	Pattern Value: SNOMED-CT Code 105421008("Educational achievement") http://hl7.org/fhir/ValueSet/usage-context-type From the FHIR Standard
Patient.extension:highestLevelOfEducation.value[x].value[x]	example	Context of Use ValueSet http://hl7.org/fhir/ValueSet/use-context From the FHIR Standard
Patient.extension:employmentStatus.value[x].code	extensible	Pattern Value: SNOMED-CT Code 224362002("Employment status") http://hl7.org/fhir/ValueSet/usage-context-type From the FHIR Standard
Patient.extension:employmentStatus.value[x].value[x]	example	Context of Use ValueSet http://hl7.org/fhir/ValueSet/use-context 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 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

Fixed: 7 elements

Extensions

This structure refers to these extensions:

• https://www.retention-project.eu/ig/StructureDefinition/PatientSex
• https://www.retention-project.eu/ig/StructureDefinition/PatientEthnicity
• https://www.retention-project.eu/ig/StructureDefinition/PatientCountryOfResidence
• https://www.retention-project.eu/ig/StructureDefinition/PatientMaritalStatus
• https://www.retention-project.eu/ig/StructureDefinition/PatientHeight
• https://www.retention-project.eu/ig/StructureDefinition/PatientAboBloodGroup
• https://www.retention-project.eu/ig/StructureDefinition/PatientHighestLevelOfEducation
• https://www.retention-project.eu/ig/StructureDefinition/PatientEmploymentStatus

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
extension:sex		0..1	(Complex)	Patient Sex URL: https://www.retention-project.eu/ig/StructureDefinition/PatientSex
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientSex"
extension:patientEthnicity		0..1	(Complex)	Patient Ethnicity URL: https://www.retention-project.eu/ig/StructureDefinition/PatientEthnicity
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientEthnicity"
extension:countryOfResidence		0..1	(Complex)	Patient Country of residence URL: https://www.retention-project.eu/ig/StructureDefinition/PatientCountryOfResidence
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientCountryOfResidence"
extension:maritalStatus		0..1	(Complex)	Patient Marital Status URL: https://www.retention-project.eu/ig/StructureDefinition/PatientMaritalStatus
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientMaritalStatus"
extension:height		0..1	UsageContext	Patient Height URL: https://www.retention-project.eu/ig/StructureDefinition/PatientHeight
extension:aboBloodGroup		0..1	(Complex)	Patient ABO blood group URL: https://www.retention-project.eu/ig/StructureDefinition/PatientAboBloodGroup
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientAboBloodGroup"
extension:highestLevelOfEducation		0..1	(Complex)	Patient Highest level of education URL: https://www.retention-project.eu/ig/StructureDefinition/PatientHighestLevelOfEducation
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientHighestLevelOfEducation"
extension:employmentStatus		0..1	(Complex)	Patient Employment status URL: https://www.retention-project.eu/ig/StructureDefinition/PatientEmploymentStatus
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientEmploymentStatus"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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	URI
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    Filter: Bindings Constraints Obligations
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
extension:sex		0..1	(Complex)	Patient Sex URL: https://www.retention-project.eu/ig/StructureDefinition/PatientSex
value[x]
value[x]
coding
system		0..1	uri	Identity of the terminology system Fixed Value: https://www.retention-project.eu/ig/CodeSystem/Sex
extension:patientEthnicity		0..1	(Complex)	Patient Ethnicity URL: https://www.retention-project.eu/ig/StructureDefinition/PatientEthnicity
value[x]
value[x]
coding
system		0..1	uri	Identity of the terminology system Fixed Value: https://www.retention-project.eu/ig/CodeSystem/Ethnicity
extension:countryOfResidence		0..1	(Complex)	Patient Country of residence URL: https://www.retention-project.eu/ig/StructureDefinition/PatientCountryOfResidence
value[x]
value[x]
coding
system		0..1	uri	Identity of the terminology system Fixed Value: https://www.retention-project.eu/ig/CodeSystem/CountryOfResidence
extension:maritalStatus		0..1	(Complex)	Patient Marital Status URL: https://www.retention-project.eu/ig/StructureDefinition/PatientMaritalStatus
value[x]
value[x]
coding
system		0..1	uri	Identity of the terminology system Fixed Value: https://www.retention-project.eu/ig/CodeSystem/MaritalStatus
extension:height		0..1	UsageContext	Patient Height URL: https://www.retention-project.eu/ig/StructureDefinition/PatientHeight
extension:aboBloodGroup		0..1	(Complex)	Patient ABO blood group URL: https://www.retention-project.eu/ig/StructureDefinition/PatientAboBloodGroup
value[x]
value[x]
coding
system		0..1	uri	Identity of the terminology system Fixed Value: https://www.retention-project.eu/ig/CodeSystem/AboBloodGroup
extension:highestLevelOfEducation		0..1	(Complex)	Patient Highest level of education URL: https://www.retention-project.eu/ig/StructureDefinition/PatientHighestLevelOfEducation
value[x]
value[x]
coding
system		0..1	uri	Identity of the terminology system Fixed Value: https://www.retention-project.eu/ig/CodeSystem/HighestLevelOfEducation
extension:employmentStatus		0..1	(Complex)	Patient Employment status URL: https://www.retention-project.eu/ig/StructureDefinition/PatientEmploymentStatus
value[x]
value[x]
coding
system		0..1	uri	Identity of the terminology system Fixed Value: https://www.retention-project.eu/ig/CodeSystem/EmploymentStatus
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:sex		0..1	(Complex)	Patient Sex URL: https://www.retention-project.eu/ig/StructureDefinition/PatientSex
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientSex"
value[x]		0..1	UsageContext	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
code	Σ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 263495000
display		1..1	string	Representation defined by the system Fixed Value: Gender
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	Σ	1..1	CodeableConcept	Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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: https://www.retention-project.eu/ig/CodeSystem/Sex
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
extension:patientEthnicity		0..1	(Complex)	Patient Ethnicity URL: https://www.retention-project.eu/ig/StructureDefinition/PatientEthnicity
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientEthnicity"
value[x]		0..1	UsageContext	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
code	Σ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 397731000
display		1..1	string	Representation defined by the system Fixed Value: Ethnic group finding
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	Σ	1..1	CodeableConcept	Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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: https://www.retention-project.eu/ig/CodeSystem/Ethnicity
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
extension:countryOfResidence		0..1	(Complex)	Patient Country of residence URL: https://www.retention-project.eu/ig/StructureDefinition/PatientCountryOfResidence
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientCountryOfResidence"
value[x]		0..1	UsageContext	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
code	Σ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 416647007
display		1..1	string	Representation defined by the system Fixed Value: Country of residence
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	Σ	1..1	CodeableConcept	Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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: https://www.retention-project.eu/ig/CodeSystem/CountryOfResidence
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
extension:maritalStatus		0..1	(Complex)	Patient Marital Status URL: https://www.retention-project.eu/ig/StructureDefinition/PatientMaritalStatus
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientMaritalStatus"
value[x]		0..1	UsageContext	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
code	Σ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 125680007
display		1..1	string	Representation defined by the system Fixed Value: Marital status
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	Σ	1..1	CodeableConcept	Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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: https://www.retention-project.eu/ig/CodeSystem/MaritalStatus
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
extension:height		0..1	UsageContext	Patient Height URL: https://www.retention-project.eu/ig/StructureDefinition/PatientHeight
extension:aboBloodGroup		0..1	(Complex)	Patient ABO blood group URL: https://www.retention-project.eu/ig/StructureDefinition/PatientAboBloodGroup
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientAboBloodGroup"
value[x]		0..1	UsageContext	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
code	Σ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 365637002
display		1..1	string	Representation defined by the system Fixed Value: Finding of ABO blood group
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	Σ	1..1	CodeableConcept	Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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: https://www.retention-project.eu/ig/CodeSystem/AboBloodGroup
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
extension:highestLevelOfEducation		0..1	(Complex)	Patient Highest level of education URL: https://www.retention-project.eu/ig/StructureDefinition/PatientHighestLevelOfEducation
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientHighestLevelOfEducation"
value[x]		0..1	UsageContext	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
code	Σ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 105421008
display		1..1	string	Representation defined by the system Fixed Value: Educational achievement
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	Σ	1..1	CodeableConcept	Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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: https://www.retention-project.eu/ig/CodeSystem/HighestLevelOfEducation
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
extension:employmentStatus		0..1	(Complex)	Patient Employment status URL: https://www.retention-project.eu/ig/StructureDefinition/PatientEmploymentStatus
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://www.retention-project.eu/ig/StructureDefinition/PatientEmploymentStatus"
value[x]		0..1	UsageContext	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
code	Σ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 224362002
display		1..1	string	Representation defined by the system Fixed Value: Employment status
userSelected		0..1	boolean	If this coding was chosen directly by the user
value[x]	Σ	1..1	CodeableConcept	Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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: https://www.retention-project.eu/ig/CodeSystem/EmploymentStatus
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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	An identifier for this patient
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 Constraints: pat-1
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 / Code	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.extension:sex.value[x].code	extensible	Pattern Value: SNOMED-CT Code 263495000("Gender") http://hl7.org/fhir/ValueSet/usage-context-type From the FHIR Standard
Patient.extension:sex.value[x].value[x]	example	Context of Use ValueSet http://hl7.org/fhir/ValueSet/use-context From the FHIR Standard
Patient.extension:patientEthnicity.value[x].code	extensible	Pattern Value: SNOMED-CT Code 397731000("Ethnic group finding") http://hl7.org/fhir/ValueSet/usage-context-type From the FHIR Standard
Patient.extension:patientEthnicity.value[x].value[x]	example	Context of Use ValueSet http://hl7.org/fhir/ValueSet/use-context From the FHIR Standard
Patient.extension:countryOfResidence.value[x].code	extensible	Pattern Value: SNOMED-CT Code 416647007("Country of residence") http://hl7.org/fhir/ValueSet/usage-context-type From the FHIR Standard
Patient.extension:countryOfResidence.value[x].value[x]	example	Context of Use ValueSet http://hl7.org/fhir/ValueSet/use-context From the FHIR Standard
Patient.extension:maritalStatus.value[x].code	extensible	Pattern Value: SNOMED-CT Code 125680007("Marital status") http://hl7.org/fhir/ValueSet/usage-context-type From the FHIR Standard
Patient.extension:maritalStatus.value[x].value[x]	example	Context of Use ValueSet http://hl7.org/fhir/ValueSet/use-context From the FHIR Standard
Patient.extension:aboBloodGroup.value[x].code	extensible	Pattern Value: SNOMED-CT Code 365637002("Finding of ABO blood group") http://hl7.org/fhir/ValueSet/usage-context-type From the FHIR Standard
Patient.extension:aboBloodGroup.value[x].value[x]	example	Context of Use ValueSet http://hl7.org/fhir/ValueSet/use-context From the FHIR Standard
Patient.extension:highestLevelOfEducation.value[x].code	extensible	Pattern Value: SNOMED-CT Code 105421008("Educational achievement") http://hl7.org/fhir/ValueSet/usage-context-type From the FHIR Standard
Patient.extension:highestLevelOfEducation.value[x].value[x]	example	Context of Use ValueSet http://hl7.org/fhir/ValueSet/use-context From the FHIR Standard
Patient.extension:employmentStatus.value[x].code	extensible	Pattern Value: SNOMED-CT Code 224362002("Employment status") http://hl7.org/fhir/ValueSet/usage-context-type From the FHIR Standard
Patient.extension:employmentStatus.value[x].value[x]	example	Context of Use ValueSet http://hl7.org/fhir/ValueSet/use-context 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 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

Fixed: 7 elements

Extensions

This structure refers to these extensions:

• https://www.retention-project.eu/ig/StructureDefinition/PatientSex
• https://www.retention-project.eu/ig/StructureDefinition/PatientEthnicity
• https://www.retention-project.eu/ig/StructureDefinition/PatientCountryOfResidence
• https://www.retention-project.eu/ig/StructureDefinition/PatientMaritalStatus
• https://www.retention-project.eu/ig/StructureDefinition/PatientHeight
• https://www.retention-project.eu/ig/StructureDefinition/PatientAboBloodGroup
• https://www.retention-project.eu/ig/StructureDefinition/PatientHighestLevelOfEducation
• https://www.retention-project.eu/ig/StructureDefinition/PatientEmploymentStatus