Subject of care - Definitions - PanCareSurPass Project HL7 FHIR Implementation Guide v0.2.0

PanCareSurPass Project HL7 FHIR Implementation Guide
0.2.0 - CI Build 150

PanCareSurPass Project HL7 FHIR Implementation Guide, published by PanCareSurPass Project. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/pcsp/ and changes regularly. See the Directory of published versions

Logical Model: Subject - Detailed Descriptions

Draft as of 2024-12-11

Definitions for the Subject logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. Subject
Definition	Subject of care Maturity Level: 2 - Ready for Review
Short	Subject of care
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. Subject.identifier
Definition	ID
Short	ID
Note	This is a business identifier, not a resource identifier (see discussion)
Control	1..*
Type	Identifier
4. Subject.name
Definition	Subject Name
Short	Subject Name
Control	1..*
Type	BackboneElement
6. Subject.name.lastname
Definition	Lastname
Short	Lastname
Control	1..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. Subject.name.middleName
Definition	Middlename
Short	Middlename
Control	0..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
10. Subject.name.firstName
Definition	Firstname
Short	Firstname
Control	1..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
12. Subject.lastnameAtDiagnosis
Definition	Lastname at diagnosis (if different from the actual one)
Short	Lastname at diagnosis (if different from the actual one)
Control	0..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
14. Subject.gender
Definition	Gender/Sex
Short	Gender/Sex
Control	1..*
Type	CodeableConcept
16. Subject.dateOfBirth
Definition	Date of birth
Short	Date of birth
Control	0..*
Type	dateTime
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. Subject.placeOfBirth
Definition	Place of birth
Short	Place of birth
Control	0..*
Type	Address
20. Subject.contact
Definition	Contact - receiver of the passport
Short	Contact - receiver of the passport
Control	0..*
Type	BackboneElement
22. Subject.contact.email
Definition	E-mail
Short	E-mail
Control	0..*
Type	uri
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
24. Subject.contact.mobile
Definition	Mobile phone
Short	Mobile phone
Control	0..*
Type	uri
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
26. Subject.contact.relationship
Definition	Relationship with the subject
Short	Relationship with the subject
Control	0..1
Type	CodeableConcept

Guidance on how to interpret the contents of this table can be found here

0. Subject
Definition	Subject of care Maturity Level: 2 - Ready for Review
Short	Subject of care
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. Subject.identifier
Definition	ID
Short	ID
Note	This is a business identifier, not a resource identifier (see discussion)
Control	1..*
Type	Identifier
4. Subject.name
Definition	Subject Name
Short	Subject Name
Control	1..*
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. Subject.name.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
8. Subject.name.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	Additional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Subject.name.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. Subject.name.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short	Extensions that cannot be ignored even if unrecognized
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary	true
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names	extensions, user content, modifiers
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Subject.name.lastname
Definition	Lastname
Short	Lastname
Control	1..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
14. Subject.name.middleName
Definition	Middlename
Short	Middlename
Control	0..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. Subject.name.firstName
Definition	Firstname
Short	Firstname
Control	1..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. Subject.lastnameAtDiagnosis
Definition	Lastname at diagnosis (if different from the actual one)
Short	Lastname at diagnosis (if different from the actual one)
Control	0..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
20. Subject.gender
Definition	Gender/Sex
Short	Gender/Sex
Control	1..*
Type	CodeableConcept
22. Subject.dateOfBirth
Definition	Date of birth
Short	Date of birth
Control	0..*
Type	dateTime
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
24. Subject.placeOfBirth
Definition	Place of birth
Short	Place of birth
Control	0..*
Type	Address
26. Subject.contact
Definition	Contact - receiver of the passport
Short	Contact - receiver of the passport
Control	0..*
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. Subject.contact.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
30. Subject.contact.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	Additional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Subject.contact.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
32. Subject.contact.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short	Extensions that cannot be ignored even if unrecognized
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary	true
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names	extensions, user content, modifiers
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. Subject.contact.email
Definition	E-mail
Short	E-mail
Control	0..*
Type	uri
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
36. Subject.contact.mobile
Definition	Mobile phone
Short	Mobile phone
Control	0..*
Type	uri
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
38. Subject.contact.relationship
Definition	Relationship with the subject
Short	Relationship with the subject
Control	0..1
Type	CodeableConcept

Guidance on how to interpret the contents of this table can be found here

0. Subject
Definition	Subject of care Maturity Level: 2 - Ready for Review
Short	Subject of care
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. Subject.identifier
Definition	ID
Short	ID
Note	This is a business identifier, not a resource identifier (see discussion)
Control	1..*
Type	Identifier
4. Subject.name
Definition	Subject Name
Short	Subject Name
Control	1..*
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. Subject.name.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
8. Subject.name.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	Additional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Subject.name.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. Subject.name.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short	Extensions that cannot be ignored even if unrecognized
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary	true
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names	extensions, user content, modifiers
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
12. Subject.name.lastname
Definition	Lastname
Short	Lastname
Control	1..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
14. Subject.name.middleName
Definition	Middlename
Short	Middlename
Control	0..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. Subject.name.firstName
Definition	Firstname
Short	Firstname
Control	1..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. Subject.lastnameAtDiagnosis
Definition	Lastname at diagnosis (if different from the actual one)
Short	Lastname at diagnosis (if different from the actual one)
Control	0..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
20. Subject.gender
Definition	Gender/Sex
Short	Gender/Sex
Control	1..*
Type	CodeableConcept
22. Subject.dateOfBirth
Definition	Date of birth
Short	Date of birth
Control	0..*
Type	dateTime
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
24. Subject.placeOfBirth
Definition	Place of birth
Short	Place of birth
Control	0..*
Type	Address
26. Subject.contact
Definition	Contact - receiver of the passport
Short	Contact - receiver of the passport
Control	0..*
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. Subject.contact.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
30. Subject.contact.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	Additional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Subject.contact.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
32. Subject.contact.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short	Extensions that cannot be ignored even if unrecognized
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary	true
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names	extensions, user content, modifiers
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
34. Subject.contact.email
Definition	E-mail
Short	E-mail
Control	0..*
Type	uri
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
36. Subject.contact.mobile
Definition	Mobile phone
Short	Mobile phone
Control	0..*
Type	uri
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
38. Subject.contact.relationship
Definition	Relationship with the subject
Short	Relationship with the subject
Control	0..1
Type	CodeableConcept

Links: Table of Contents | QA Report

The PanCareSurPass Research and Innovation Action has received funding from the European Union's Horizon 2020
research and innovation programme under grant agreement No. 899999.