PanCareSurPass Project HL7 FHIR Implementation Guide
0.1.0 - trial-use 150

This page is part of the PanCareSurPass Project HL7 FHIR Implementation Guide (v0.1.0: QA Preview) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: Subject - Detailed Descriptions

Active as of 2023-01-26

Definitions for the Subject logical model.

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

1. Subject
Definition

Subject of care Maturity Level: 2 - Ready for Review

Control0..?
2. Subject.identifier
Definition

ID

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
3. Subject.name
Definition

Subject Name

Control1..*
TypeBackboneElement
4. Subject.name.lastname
Definition

Lastname

Control1..*
Typestring
5. Subject.name.middleName
Definition

Middlename

Control0..*
Typestring
6. Subject.name.firstName
Definition

Firstname

Control1..*
Typestring
7. Subject.lastnameAtDiagnosis
Definition

Lastname at diagnosis (if different from the actual one)

Control0..*
Typestring
8. Subject.gender
Definition

Gender/Sex

Control1..*
TypeCodeableConcept
9. Subject.dateOfBirth
Definition

Date of birth

Control0..*
TypedateTime
10. Subject.placeOfBirth
Definition

Place of birth

Control0..*
TypeAddress
11. Subject.contact
Definition

Contact - receiver of the passport

Control0..*
TypeBackboneElement
12. Subject.contact.email
Definition

E-mail

Control0..*
Typeuri
13. Subject.contact.mobile
Definition

Mobile phone

Control0..*
Typeuri
14. Subject.contact.relationship
Definition

Relationship with the subject

Control0..1
TypeCodeableConcept

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

1. Subject
Definition

Subject of care Maturity Level: 2 - Ready for Review

Control0..*
2. Subject.identifier
Definition

ID

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
3. Subject.name
Definition

Subject Name

Control1..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. 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).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
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 Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
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())
5. Subject.name.lastname
Definition

Lastname

Control1..*
Typestring
6. Subject.name.middleName
Definition

Middlename

Control0..*
Typestring
7. Subject.name.firstName
Definition

Firstname

Control1..*
Typestring
8. Subject.lastnameAtDiagnosis
Definition

Lastname at diagnosis (if different from the actual one)

Control0..*
Typestring
9. Subject.gender
Definition

Gender/Sex

Control1..*
TypeCodeableConcept
10. Subject.dateOfBirth
Definition

Date of birth

Control0..*
TypedateTime
11. Subject.placeOfBirth
Definition

Place of birth

Control0..*
TypeAddress
12. Subject.contact
Definition

Contact - receiver of the passport

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. 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).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
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 Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
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())
14. Subject.contact.email
Definition

E-mail

Control0..*
Typeuri
15. Subject.contact.mobile
Definition

Mobile phone

Control0..*
Typeuri
16. Subject.contact.relationship
Definition

Relationship with the subject

Control0..1
TypeCodeableConcept

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

1. Subject
Definition

Subject of care Maturity Level: 2 - Ready for Review

Control0..*
2. Subject.identifier
Definition

ID

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
3. Subject.name
Definition

Subject Name

Control1..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
5. 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.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Subject.name.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. 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).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
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 Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
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())
7. Subject.name.lastname
Definition

Lastname

Control1..*
Typestring
8. Subject.name.middleName
Definition

Middlename

Control0..*
Typestring
9. Subject.name.firstName
Definition

Firstname

Control1..*
Typestring
10. Subject.lastnameAtDiagnosis
Definition

Lastname at diagnosis (if different from the actual one)

Control0..*
Typestring
11. Subject.gender
Definition

Gender/Sex

Control1..*
TypeCodeableConcept
12. Subject.dateOfBirth
Definition

Date of birth

Control0..*
TypedateTime
13. Subject.placeOfBirth
Definition

Place of birth

Control0..*
TypeAddress
14. Subject.contact
Definition

Contact - receiver of the passport

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
16. 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.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Subject.contact.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
17. 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).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
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 Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
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())
18. Subject.contact.email
Definition

E-mail

Control0..*
Typeuri
19. Subject.contact.mobile
Definition

Mobile phone

Control0..*
Typeuri
20. Subject.contact.relationship
Definition

Relationship with the subject

Control0..1
TypeCodeableConcept