Social Care Interoperability Platform FHIR Implementation Guide
Version: 0.1.0, Status: draft

Social Care Interoperability Platform FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: MODS Subject of Care

Official URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-SubjectOfCare Version: 0.1.0
Draft as of 2026-03-24 Computable Name: MODSSubjectOfCare

MODS Definition: A person who seeks to receive, is receiving, or has received care.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MODS-SubjectOfCare 0..* Element MODS Subject of Care

Elements defined in Ancestors:@id, extension
Instances of this logical model can be the target of a Reference
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... name 1..1 BackboneElement Person Name
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... family 1..1 string Person Family/Surname
.... given 1..1 string Person Given/Forename
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... nhsNumber 1..1 BackboneElement Person NHS Number
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value C 1..1 string NHS Number
Constraints: nhsnumber-invariant
..... statusIndicator 1..1 Coding NHS Number Trace Status Indicator
Binding: NHS Number Verification Status (required)
.... otherIdentifier 0..* BackboneElement Person Other Identifier
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value 1..1 string Identifier Value
..... system 1..1 url A URL indicating the identifier’s system or type, used as a logical business identifier rather than a database key.
... demographics 1..1 BackboneElement Person Demographics
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dateOfBirth C 1..1 dateTime Date Of Birth
Constraints: birthdeathdate-invariant
.... sex 1..1 Coding Person Sex
Binding: MODS Person Sex (Birth Sex) Code (required)
.... maritalStatus 1..1 Coding Person Marital Status
Binding: MODS Person Marital Status Code (required)
.... ethnicity 1..1 Coding Person Ethnicity
Binding: MODS Person Ethnicity Code (required)
.... genderIdentity 1..1 Coding Person Gender Identity
Binding: MODS Person Gender Identity Code (required)
.... religion 1..1 Coding Person Religion
Binding: MODS Person Religion Code (required)
.... sexualOrientation 1..1 Coding Person Sexual Orientation
Binding: MODS Person Sexual Orientation Code (required)
.... firstLanguage 0..1 Coding Person First Language
Binding: AllLanguages (required)
.... otherLanguage 0..1 Coding Person Other Language
Binding: AllLanguages (required)
.... interpreterRequired 0..1 boolean Person Interpreter Required
.... immigrationStatus 0..1 string Person Immigration Status
.... primaryNationality 0..1 Coding Person Primary Nationality
Binding: MODS Country (required)
.... otherNationality 0..1 Coding Person Other Nationality
Binding: MODS Country (required)
.... pregnancyStatus 0..1 Coding Female Pregnancy Status
Binding: MODS Female Pregnancy Status (required)
.... pronouns 0..1 string Person Pronouns
... address 1..* BackboneElement Person Address
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... addressEntry1 C 1..1 string First address line
Constraints: addressline-invariant
.... addressEntry2 C 0..1 string Second address line
Constraints: addressline-invariant
.... addressEntry3 C 0..1 string Third address line
Constraints: addressline-invariant
.... addressEntry4 C 0..1 string Fourth address line
Constraints: addressline-invariant
.... postCode C 1..1 string Address postal code
Constraints: addresspostcode-invariant
.... country 0..1 Coding Address Country
Binding: MODS Country (required)
... contactDetails 1..1 BackboneElement Person Contact Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... emailAddressDetails 0..* BackboneElement Person Contact Email Address Details
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... emailAddress C 1..1 string Email address
Constraints: emailaddress-invariant
..... preferredOrder 0..1 positiveInt 1 indicates the preferred choice. Empty/not present indicates no preference.
..... type 1..1 Coding Contact Email address type
Binding: MODS Email Address Type (required)
.... telephoneDetails 0..* BackboneElement Person Contact Telephone Number Details
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... telephoneNumber C 1..1 string Telephone Number
Constraints: telephonenumber-invariant
..... preferredOrder 0..1 positiveInt 1 indicates the preferred choice. Empty/not present indicates no preference.
..... type 1..1 Coding Contact Telephone Number type
Binding: MODS Person Telephone Number Type Code (required)
... deathDetails 0..1 BackboneElement Person Death Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... deathCauseIdentificationMethod 0..1 Coding Death Cause Identification Method
Binding: MODS Death Cause Identification Method Code (required)
.... deathLocationType 0..1 Coding Preferred Death Location Type
Binding: MODS Death Location Type Code (required)
.... deathNotAtPreferredLocationReason 0..1 Coding Death not at preferred location reason
Binding: MODS Death not at Preferred Location Reason Code (required)
.... personDeathDate C 0..1 dateTime Person Death Date
Constraints: birthdeathdate-invariant
.... personDeathTime C 0..1 time Person Time of Death
Constraints: deathtime-invariant
.... personAtRiskOfUnexpectedDeath 0..1 Coding Person at Risk of Unexpected Death
Binding: MODS Person At Risk Of Unexpected Death Indicator (required)
.... preferredDeathLocationDiscussedIndicator 0..1 Coding Preferred Death Location Discussed Indicator
Binding: MODS Person Preferred Location of Death Discussed Indicator (required)
... careProvider 0..* Reference(MODS Care Organisation) A provider organisation, registered with the Care Quality Commission to provide personal care and support to the Subject of care.
... generalPractice 0..1 Reference(MODS Care Organisation) Person's registered GP practice

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MODS-SubjectOfCare.identification.​nhsNumber.statusIndicator Base required NHS Number Verification Status 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​sex Base required MODS Person Sex (Birth Sex) Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​maritalStatus Base required MODS Person Marital Status Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​ethnicity Base required MODS Person Ethnicity Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​genderIdentity Base required MODS Person Gender Identity Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​religion Base required MODS Person Religion Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​sexualOrientation Base required MODS Person Sexual Orientation Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​firstLanguage Base required All Languages 📦4.0.1 FHIR Std.
MODS-SubjectOfCare.demographics.​otherLanguage Base required All Languages 📦4.0.1 FHIR Std.
MODS-SubjectOfCare.demographics.​primaryNationality Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​otherNationality Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​pregnancyStatus Base required MODS Female Pregnancy Status 📦0.1.0 This IG
MODS-SubjectOfCare.address.​country Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.contactDetails.​emailAddressDetails.​type Base required MODS Email Address Type 📦0.1.0 This IG
MODS-SubjectOfCare.contactDetails.​telephoneDetails.type Base required MODS Person Telephone Number Type Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathCauseIdentificationMethod Base required MODS Death Cause Identification Method Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathLocationType Base required MODS Death Location Type Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathNotAtPreferredLocationReason Base required MODS Death not at Preferred Location Reason Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​personAtRiskOfUnexpectedDeath Base required MODS Person At Risk Of Unexpected Death Indicator 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​preferredDeathLocationDiscussedIndicator Base required MODS Person Preferred Location of Death Discussed Indicator 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
addressline-invariant error MODS-SubjectOfCare.address.addressEntry1, MODS-SubjectOfCare.address.addressEntry2, MODS-SubjectOfCare.address.addressEntry3, MODS-SubjectOfCare.address.addressEntry4 Address lines MUST not exceed 35 characters in length $this.length() <= 35
addresspostcode-invariant error MODS-SubjectOfCare.address.postCode Only UK postcodes are valid $this.matches('^[a-zA-Z0-9]{0,8}$') and $this.length() <= 8
birthdeathdate-invariant error MODS-SubjectOfCare.demographics.dateOfBirth, MODS-SubjectOfCare.deathDetails.personDeathDate Subject of Care Birth and Death date MUST be represented as Dates (YYYY-MM-DD only) $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
deathtime-invariant error MODS-SubjectOfCare.deathDetails.personDeathTime Subject of Care Time of Death, in the format hh:mm:ss $this.matches('([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
emailaddress-invariant error MODS-SubjectOfCare.contactDetails.emailAddressDetails.emailAddress MUST be a valid email address $this.matches('[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$')
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nhsnumber-invariant error MODS-SubjectOfCare.identification.nhsNumber.value 10-digit NHS Number (leading zeros allowed). MUST be exactly 10 digits (numeric only) $this.matches('^\d{10}$')
telephonenumber-invariant error MODS-SubjectOfCare.contactDetails.telephoneDetails.telephoneNumber Telephone Numbers MUST be valid UK land line or mobile number, contain digits only, and not exceed 35 characters length $this.matches('^(?:\+44\s?|0)(?:\s?\d){9,10}$') and $this.length() <= 35

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MODS-SubjectOfCare 0..* Element MODS Subject of Care

Elements defined in Ancestors:@id, extension
Instances of this logical model can be the target of a Reference
... name 1..1 BackboneElement Person Name
.... family 1..1 string Person Family/Surname
.... given 1..1 string Person Given/Forename
... identification 1..1 BackboneElement Person Identification
.... nhsNumber 1..1 BackboneElement Person NHS Number
..... value C 1..1 string NHS Number
Constraints: nhsnumber-invariant
..... statusIndicator 1..1 Coding NHS Number Trace Status Indicator
Binding: NHS Number Verification Status (required)
.... otherIdentifier 0..* BackboneElement Person Other Identifier
..... value 1..1 string Identifier Value
..... system 1..1 url A URL indicating the identifier’s system or type, used as a logical business identifier rather than a database key.
... demographics 1..1 BackboneElement Person Demographics
.... dateOfBirth C 1..1 dateTime Date Of Birth
Constraints: birthdeathdate-invariant
.... sex 1..1 Coding Person Sex
Binding: MODS Person Sex (Birth Sex) Code (required)
.... maritalStatus 1..1 Coding Person Marital Status
Binding: MODS Person Marital Status Code (required)
.... ethnicity 1..1 Coding Person Ethnicity
Binding: MODS Person Ethnicity Code (required)
.... genderIdentity 1..1 Coding Person Gender Identity
Binding: MODS Person Gender Identity Code (required)
.... religion 1..1 Coding Person Religion
Binding: MODS Person Religion Code (required)
.... sexualOrientation 1..1 Coding Person Sexual Orientation
Binding: MODS Person Sexual Orientation Code (required)
.... firstLanguage 0..1 Coding Person First Language
Binding: AllLanguages (required)
.... otherLanguage 0..1 Coding Person Other Language
Binding: AllLanguages (required)
.... interpreterRequired 0..1 boolean Person Interpreter Required
.... immigrationStatus 0..1 string Person Immigration Status
.... primaryNationality 0..1 Coding Person Primary Nationality
Binding: MODS Country (required)
.... otherNationality 0..1 Coding Person Other Nationality
Binding: MODS Country (required)
.... pregnancyStatus 0..1 Coding Female Pregnancy Status
Binding: MODS Female Pregnancy Status (required)
.... pronouns 0..1 string Person Pronouns
.... addressEntry1 C 1..1 string First address line
Constraints: addressline-invariant
.... addressEntry2 C 0..1 string Second address line
Constraints: addressline-invariant
.... addressEntry3 C 0..1 string Third address line
Constraints: addressline-invariant
.... addressEntry4 C 0..1 string Fourth address line
Constraints: addressline-invariant
.... postCode C 1..1 string Address postal code
Constraints: addresspostcode-invariant
.... country 0..1 Coding Address Country
Binding: MODS Country (required)
... contactDetails 1..1 BackboneElement Person Contact Details
.... emailAddressDetails 0..* BackboneElement Person Contact Email Address Details
..... emailAddress C 1..1 string Email address
Constraints: emailaddress-invariant
..... preferredOrder 0..1 positiveInt 1 indicates the preferred choice. Empty/not present indicates no preference.
..... type 1..1 Coding Contact Email address type
Binding: MODS Email Address Type (required)
.... telephoneDetails 0..* BackboneElement Person Contact Telephone Number Details
..... telephoneNumber C 1..1 string Telephone Number
Constraints: telephonenumber-invariant
..... preferredOrder 0..1 positiveInt 1 indicates the preferred choice. Empty/not present indicates no preference.
..... type 1..1 Coding Contact Telephone Number type
Binding: MODS Person Telephone Number Type Code (required)
... deathDetails 0..1 BackboneElement Person Death Details
.... deathCauseIdentificationMethod 0..1 Coding Death Cause Identification Method
Binding: MODS Death Cause Identification Method Code (required)
.... deathLocationType 0..1 Coding Preferred Death Location Type
Binding: MODS Death Location Type Code (required)
.... deathNotAtPreferredLocationReason 0..1 Coding Death not at preferred location reason
Binding: MODS Death not at Preferred Location Reason Code (required)
.... personDeathDate C 0..1 dateTime Person Death Date
Constraints: birthdeathdate-invariant
.... personDeathTime C 0..1 time Person Time of Death
Constraints: deathtime-invariant
.... personAtRiskOfUnexpectedDeath 0..1 Coding Person at Risk of Unexpected Death
Binding: MODS Person At Risk Of Unexpected Death Indicator (required)
.... preferredDeathLocationDiscussedIndicator 0..1 Coding Preferred Death Location Discussed Indicator
Binding: MODS Person Preferred Location of Death Discussed Indicator (required)
... careProvider 0..* Reference(MODS Care Organisation) A provider organisation, registered with the Care Quality Commission to provide personal care and support to the Subject of care.
... generalPractice 0..1 Reference(MODS Care Organisation) Person's registered GP practice

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MODS-SubjectOfCare.identification.​nhsNumber.statusIndicator Base required NHS Number Verification Status 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​sex Base required MODS Person Sex (Birth Sex) Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​maritalStatus Base required MODS Person Marital Status Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​ethnicity Base required MODS Person Ethnicity Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​genderIdentity Base required MODS Person Gender Identity Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​religion Base required MODS Person Religion Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​sexualOrientation Base required MODS Person Sexual Orientation Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​firstLanguage Base required All Languages 📦4.0.1 FHIR Std.
MODS-SubjectOfCare.demographics.​otherLanguage Base required All Languages 📦4.0.1 FHIR Std.
MODS-SubjectOfCare.demographics.​primaryNationality Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​otherNationality Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​pregnancyStatus Base required MODS Female Pregnancy Status 📦0.1.0 This IG
MODS-SubjectOfCare.address.​country Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.contactDetails.​emailAddressDetails.​type Base required MODS Email Address Type 📦0.1.0 This IG
MODS-SubjectOfCare.contactDetails.​telephoneDetails.type Base required MODS Person Telephone Number Type Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathCauseIdentificationMethod Base required MODS Death Cause Identification Method Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathLocationType Base required MODS Death Location Type Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathNotAtPreferredLocationReason Base required MODS Death not at Preferred Location Reason Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​personAtRiskOfUnexpectedDeath Base required MODS Person At Risk Of Unexpected Death Indicator 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​preferredDeathLocationDiscussedIndicator Base required MODS Person Preferred Location of Death Discussed Indicator 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
addressline-invariant error MODS-SubjectOfCare.address.addressEntry1, MODS-SubjectOfCare.address.addressEntry2, MODS-SubjectOfCare.address.addressEntry3, MODS-SubjectOfCare.address.addressEntry4 Address lines MUST not exceed 35 characters in length $this.length() <= 35
addresspostcode-invariant error MODS-SubjectOfCare.address.postCode Only UK postcodes are valid $this.matches('^[a-zA-Z0-9]{0,8}$') and $this.length() <= 8
birthdeathdate-invariant error MODS-SubjectOfCare.demographics.dateOfBirth, MODS-SubjectOfCare.deathDetails.personDeathDate Subject of Care Birth and Death date MUST be represented as Dates (YYYY-MM-DD only) $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
deathtime-invariant error MODS-SubjectOfCare.deathDetails.personDeathTime Subject of Care Time of Death, in the format hh:mm:ss $this.matches('([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?')
emailaddress-invariant error MODS-SubjectOfCare.contactDetails.emailAddressDetails.emailAddress MUST be a valid email address $this.matches('[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$')
nhsnumber-invariant error MODS-SubjectOfCare.identification.nhsNumber.value 10-digit NHS Number (leading zeros allowed). MUST be exactly 10 digits (numeric only) $this.matches('^\d{10}$')
telephonenumber-invariant error MODS-SubjectOfCare.contactDetails.telephoneDetails.telephoneNumber Telephone Numbers MUST be valid UK land line or mobile number, contain digits only, and not exceed 35 characters length $this.matches('^(?:\+44\s?|0)(?:\s?\d){9,10}$') and $this.length() <= 35
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MODS-SubjectOfCare 0..* Element MODS Subject of Care

Elements defined in Ancestors:@id, extension
Instances of this logical model can be the target of a Reference
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... name 1..1 BackboneElement Person Name
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... family 1..1 string Person Family/Surname
.... given 1..1 string Person Given/Forename
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... nhsNumber 1..1 BackboneElement Person NHS Number
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value C 1..1 string NHS Number
Constraints: nhsnumber-invariant
..... statusIndicator 1..1 Coding NHS Number Trace Status Indicator
Binding: NHS Number Verification Status (required)
.... otherIdentifier 0..* BackboneElement Person Other Identifier
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value 1..1 string Identifier Value
..... system 1..1 url A URL indicating the identifier’s system or type, used as a logical business identifier rather than a database key.
... demographics 1..1 BackboneElement Person Demographics
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dateOfBirth C 1..1 dateTime Date Of Birth
Constraints: birthdeathdate-invariant
.... sex 1..1 Coding Person Sex
Binding: MODS Person Sex (Birth Sex) Code (required)
.... maritalStatus 1..1 Coding Person Marital Status
Binding: MODS Person Marital Status Code (required)
.... ethnicity 1..1 Coding Person Ethnicity
Binding: MODS Person Ethnicity Code (required)
.... genderIdentity 1..1 Coding Person Gender Identity
Binding: MODS Person Gender Identity Code (required)
.... religion 1..1 Coding Person Religion
Binding: MODS Person Religion Code (required)
.... sexualOrientation 1..1 Coding Person Sexual Orientation
Binding: MODS Person Sexual Orientation Code (required)
.... firstLanguage 0..1 Coding Person First Language
Binding: AllLanguages (required)
.... otherLanguage 0..1 Coding Person Other Language
Binding: AllLanguages (required)
.... interpreterRequired 0..1 boolean Person Interpreter Required
.... immigrationStatus 0..1 string Person Immigration Status
.... primaryNationality 0..1 Coding Person Primary Nationality
Binding: MODS Country (required)
.... otherNationality 0..1 Coding Person Other Nationality
Binding: MODS Country (required)
.... pregnancyStatus 0..1 Coding Female Pregnancy Status
Binding: MODS Female Pregnancy Status (required)
.... pronouns 0..1 string Person Pronouns
... address 1..* BackboneElement Person Address
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... addressEntry1 C 1..1 string First address line
Constraints: addressline-invariant
.... addressEntry2 C 0..1 string Second address line
Constraints: addressline-invariant
.... addressEntry3 C 0..1 string Third address line
Constraints: addressline-invariant
.... addressEntry4 C 0..1 string Fourth address line
Constraints: addressline-invariant
.... postCode C 1..1 string Address postal code
Constraints: addresspostcode-invariant
.... country 0..1 Coding Address Country
Binding: MODS Country (required)
... contactDetails 1..1 BackboneElement Person Contact Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... emailAddressDetails 0..* BackboneElement Person Contact Email Address Details
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... emailAddress C 1..1 string Email address
Constraints: emailaddress-invariant
..... preferredOrder 0..1 positiveInt 1 indicates the preferred choice. Empty/not present indicates no preference.
..... type 1..1 Coding Contact Email address type
Binding: MODS Email Address Type (required)
.... telephoneDetails 0..* BackboneElement Person Contact Telephone Number Details
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... telephoneNumber C 1..1 string Telephone Number
Constraints: telephonenumber-invariant
..... preferredOrder 0..1 positiveInt 1 indicates the preferred choice. Empty/not present indicates no preference.
..... type 1..1 Coding Contact Telephone Number type
Binding: MODS Person Telephone Number Type Code (required)
... deathDetails 0..1 BackboneElement Person Death Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... deathCauseIdentificationMethod 0..1 Coding Death Cause Identification Method
Binding: MODS Death Cause Identification Method Code (required)
.... deathLocationType 0..1 Coding Preferred Death Location Type
Binding: MODS Death Location Type Code (required)
.... deathNotAtPreferredLocationReason 0..1 Coding Death not at preferred location reason
Binding: MODS Death not at Preferred Location Reason Code (required)
.... personDeathDate C 0..1 dateTime Person Death Date
Constraints: birthdeathdate-invariant
.... personDeathTime C 0..1 time Person Time of Death
Constraints: deathtime-invariant
.... personAtRiskOfUnexpectedDeath 0..1 Coding Person at Risk of Unexpected Death
Binding: MODS Person At Risk Of Unexpected Death Indicator (required)
.... preferredDeathLocationDiscussedIndicator 0..1 Coding Preferred Death Location Discussed Indicator
Binding: MODS Person Preferred Location of Death Discussed Indicator (required)
... careProvider 0..* Reference(MODS Care Organisation) A provider organisation, registered with the Care Quality Commission to provide personal care and support to the Subject of care.
... generalPractice 0..1 Reference(MODS Care Organisation) Person's registered GP practice

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MODS-SubjectOfCare.identification.​nhsNumber.statusIndicator Base required NHS Number Verification Status 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​sex Base required MODS Person Sex (Birth Sex) Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​maritalStatus Base required MODS Person Marital Status Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​ethnicity Base required MODS Person Ethnicity Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​genderIdentity Base required MODS Person Gender Identity Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​religion Base required MODS Person Religion Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​sexualOrientation Base required MODS Person Sexual Orientation Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​firstLanguage Base required All Languages 📦4.0.1 FHIR Std.
MODS-SubjectOfCare.demographics.​otherLanguage Base required All Languages 📦4.0.1 FHIR Std.
MODS-SubjectOfCare.demographics.​primaryNationality Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​otherNationality Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​pregnancyStatus Base required MODS Female Pregnancy Status 📦0.1.0 This IG
MODS-SubjectOfCare.address.​country Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.contactDetails.​emailAddressDetails.​type Base required MODS Email Address Type 📦0.1.0 This IG
MODS-SubjectOfCare.contactDetails.​telephoneDetails.type Base required MODS Person Telephone Number Type Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathCauseIdentificationMethod Base required MODS Death Cause Identification Method Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathLocationType Base required MODS Death Location Type Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathNotAtPreferredLocationReason Base required MODS Death not at Preferred Location Reason Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​personAtRiskOfUnexpectedDeath Base required MODS Person At Risk Of Unexpected Death Indicator 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​preferredDeathLocationDiscussedIndicator Base required MODS Person Preferred Location of Death Discussed Indicator 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
addressline-invariant error MODS-SubjectOfCare.address.addressEntry1, MODS-SubjectOfCare.address.addressEntry2, MODS-SubjectOfCare.address.addressEntry3, MODS-SubjectOfCare.address.addressEntry4 Address lines MUST not exceed 35 characters in length $this.length() <= 35
addresspostcode-invariant error MODS-SubjectOfCare.address.postCode Only UK postcodes are valid $this.matches('^[a-zA-Z0-9]{0,8}$') and $this.length() <= 8
birthdeathdate-invariant error MODS-SubjectOfCare.demographics.dateOfBirth, MODS-SubjectOfCare.deathDetails.personDeathDate Subject of Care Birth and Death date MUST be represented as Dates (YYYY-MM-DD only) $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
deathtime-invariant error MODS-SubjectOfCare.deathDetails.personDeathTime Subject of Care Time of Death, in the format hh:mm:ss $this.matches('([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
emailaddress-invariant error MODS-SubjectOfCare.contactDetails.emailAddressDetails.emailAddress MUST be a valid email address $this.matches('[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$')
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nhsnumber-invariant error MODS-SubjectOfCare.identification.nhsNumber.value 10-digit NHS Number (leading zeros allowed). MUST be exactly 10 digits (numeric only) $this.matches('^\d{10}$')
telephonenumber-invariant error MODS-SubjectOfCare.contactDetails.telephoneDetails.telephoneNumber Telephone Numbers MUST be valid UK land line or mobile number, contain digits only, and not exceed 35 characters length $this.matches('^(?:\+44\s?|0)(?:\s?\d){9,10}$') and $this.length() <= 35

This structure is derived from Element

Summary

Mandatory: 0 element(25 nested mandatory elements)

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MODS-SubjectOfCare 0..* Element MODS Subject of Care

Elements defined in Ancestors:@id, extension
Instances of this logical model can be the target of a Reference
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... name 1..1 BackboneElement Person Name
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... family 1..1 string Person Family/Surname
.... given 1..1 string Person Given/Forename
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... nhsNumber 1..1 BackboneElement Person NHS Number
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value C 1..1 string NHS Number
Constraints: nhsnumber-invariant
..... statusIndicator 1..1 Coding NHS Number Trace Status Indicator
Binding: NHS Number Verification Status (required)
.... otherIdentifier 0..* BackboneElement Person Other Identifier
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value 1..1 string Identifier Value
..... system 1..1 url A URL indicating the identifier’s system or type, used as a logical business identifier rather than a database key.
... demographics 1..1 BackboneElement Person Demographics
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dateOfBirth C 1..1 dateTime Date Of Birth
Constraints: birthdeathdate-invariant
.... sex 1..1 Coding Person Sex
Binding: MODS Person Sex (Birth Sex) Code (required)
.... maritalStatus 1..1 Coding Person Marital Status
Binding: MODS Person Marital Status Code (required)
.... ethnicity 1..1 Coding Person Ethnicity
Binding: MODS Person Ethnicity Code (required)
.... genderIdentity 1..1 Coding Person Gender Identity
Binding: MODS Person Gender Identity Code (required)
.... religion 1..1 Coding Person Religion
Binding: MODS Person Religion Code (required)
.... sexualOrientation 1..1 Coding Person Sexual Orientation
Binding: MODS Person Sexual Orientation Code (required)
.... firstLanguage 0..1 Coding Person First Language
Binding: AllLanguages (required)
.... otherLanguage 0..1 Coding Person Other Language
Binding: AllLanguages (required)
.... interpreterRequired 0..1 boolean Person Interpreter Required
.... immigrationStatus 0..1 string Person Immigration Status
.... primaryNationality 0..1 Coding Person Primary Nationality
Binding: MODS Country (required)
.... otherNationality 0..1 Coding Person Other Nationality
Binding: MODS Country (required)
.... pregnancyStatus 0..1 Coding Female Pregnancy Status
Binding: MODS Female Pregnancy Status (required)
.... pronouns 0..1 string Person Pronouns
... address 1..* BackboneElement Person Address
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... addressEntry1 C 1..1 string First address line
Constraints: addressline-invariant
.... addressEntry2 C 0..1 string Second address line
Constraints: addressline-invariant
.... addressEntry3 C 0..1 string Third address line
Constraints: addressline-invariant
.... addressEntry4 C 0..1 string Fourth address line
Constraints: addressline-invariant
.... postCode C 1..1 string Address postal code
Constraints: addresspostcode-invariant
.... country 0..1 Coding Address Country
Binding: MODS Country (required)
... contactDetails 1..1 BackboneElement Person Contact Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... emailAddressDetails 0..* BackboneElement Person Contact Email Address Details
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... emailAddress C 1..1 string Email address
Constraints: emailaddress-invariant
..... preferredOrder 0..1 positiveInt 1 indicates the preferred choice. Empty/not present indicates no preference.
..... type 1..1 Coding Contact Email address type
Binding: MODS Email Address Type (required)
.... telephoneDetails 0..* BackboneElement Person Contact Telephone Number Details
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... telephoneNumber C 1..1 string Telephone Number
Constraints: telephonenumber-invariant
..... preferredOrder 0..1 positiveInt 1 indicates the preferred choice. Empty/not present indicates no preference.
..... type 1..1 Coding Contact Telephone Number type
Binding: MODS Person Telephone Number Type Code (required)
... deathDetails 0..1 BackboneElement Person Death Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... deathCauseIdentificationMethod 0..1 Coding Death Cause Identification Method
Binding: MODS Death Cause Identification Method Code (required)
.... deathLocationType 0..1 Coding Preferred Death Location Type
Binding: MODS Death Location Type Code (required)
.... deathNotAtPreferredLocationReason 0..1 Coding Death not at preferred location reason
Binding: MODS Death not at Preferred Location Reason Code (required)
.... personDeathDate C 0..1 dateTime Person Death Date
Constraints: birthdeathdate-invariant
.... personDeathTime C 0..1 time Person Time of Death
Constraints: deathtime-invariant
.... personAtRiskOfUnexpectedDeath 0..1 Coding Person at Risk of Unexpected Death
Binding: MODS Person At Risk Of Unexpected Death Indicator (required)
.... preferredDeathLocationDiscussedIndicator 0..1 Coding Preferred Death Location Discussed Indicator
Binding: MODS Person Preferred Location of Death Discussed Indicator (required)
... careProvider 0..* Reference(MODS Care Organisation) A provider organisation, registered with the Care Quality Commission to provide personal care and support to the Subject of care.
... generalPractice 0..1 Reference(MODS Care Organisation) Person's registered GP practice

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MODS-SubjectOfCare.identification.​nhsNumber.statusIndicator Base required NHS Number Verification Status 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​sex Base required MODS Person Sex (Birth Sex) Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​maritalStatus Base required MODS Person Marital Status Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​ethnicity Base required MODS Person Ethnicity Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​genderIdentity Base required MODS Person Gender Identity Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​religion Base required MODS Person Religion Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​sexualOrientation Base required MODS Person Sexual Orientation Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​firstLanguage Base required All Languages 📦4.0.1 FHIR Std.
MODS-SubjectOfCare.demographics.​otherLanguage Base required All Languages 📦4.0.1 FHIR Std.
MODS-SubjectOfCare.demographics.​primaryNationality Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​otherNationality Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​pregnancyStatus Base required MODS Female Pregnancy Status 📦0.1.0 This IG
MODS-SubjectOfCare.address.​country Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.contactDetails.​emailAddressDetails.​type Base required MODS Email Address Type 📦0.1.0 This IG
MODS-SubjectOfCare.contactDetails.​telephoneDetails.type Base required MODS Person Telephone Number Type Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathCauseIdentificationMethod Base required MODS Death Cause Identification Method Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathLocationType Base required MODS Death Location Type Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathNotAtPreferredLocationReason Base required MODS Death not at Preferred Location Reason Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​personAtRiskOfUnexpectedDeath Base required MODS Person At Risk Of Unexpected Death Indicator 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​preferredDeathLocationDiscussedIndicator Base required MODS Person Preferred Location of Death Discussed Indicator 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
addressline-invariant error MODS-SubjectOfCare.address.addressEntry1, MODS-SubjectOfCare.address.addressEntry2, MODS-SubjectOfCare.address.addressEntry3, MODS-SubjectOfCare.address.addressEntry4 Address lines MUST not exceed 35 characters in length $this.length() <= 35
addresspostcode-invariant error MODS-SubjectOfCare.address.postCode Only UK postcodes are valid $this.matches('^[a-zA-Z0-9]{0,8}$') and $this.length() <= 8
birthdeathdate-invariant error MODS-SubjectOfCare.demographics.dateOfBirth, MODS-SubjectOfCare.deathDetails.personDeathDate Subject of Care Birth and Death date MUST be represented as Dates (YYYY-MM-DD only) $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
deathtime-invariant error MODS-SubjectOfCare.deathDetails.personDeathTime Subject of Care Time of Death, in the format hh:mm:ss $this.matches('([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
emailaddress-invariant error MODS-SubjectOfCare.contactDetails.emailAddressDetails.emailAddress MUST be a valid email address $this.matches('[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$')
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nhsnumber-invariant error MODS-SubjectOfCare.identification.nhsNumber.value 10-digit NHS Number (leading zeros allowed). MUST be exactly 10 digits (numeric only) $this.matches('^\d{10}$')
telephonenumber-invariant error MODS-SubjectOfCare.contactDetails.telephoneDetails.telephoneNumber Telephone Numbers MUST be valid UK land line or mobile number, contain digits only, and not exceed 35 characters length $this.matches('^(?:\+44\s?|0)(?:\s?\d){9,10}$') and $this.length() <= 35

Differential View

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MODS-SubjectOfCare 0..* Element MODS Subject of Care

Elements defined in Ancestors:@id, extension
Instances of this logical model can be the target of a Reference
... name 1..1 BackboneElement Person Name
.... family 1..1 string Person Family/Surname
.... given 1..1 string Person Given/Forename
... identification 1..1 BackboneElement Person Identification
.... nhsNumber 1..1 BackboneElement Person NHS Number
..... value C 1..1 string NHS Number
Constraints: nhsnumber-invariant
..... statusIndicator 1..1 Coding NHS Number Trace Status Indicator
Binding: NHS Number Verification Status (required)
.... otherIdentifier 0..* BackboneElement Person Other Identifier
..... value 1..1 string Identifier Value
..... system 1..1 url A URL indicating the identifier’s system or type, used as a logical business identifier rather than a database key.
... demographics 1..1 BackboneElement Person Demographics
.... dateOfBirth C 1..1 dateTime Date Of Birth
Constraints: birthdeathdate-invariant
.... sex 1..1 Coding Person Sex
Binding: MODS Person Sex (Birth Sex) Code (required)
.... maritalStatus 1..1 Coding Person Marital Status
Binding: MODS Person Marital Status Code (required)
.... ethnicity 1..1 Coding Person Ethnicity
Binding: MODS Person Ethnicity Code (required)
.... genderIdentity 1..1 Coding Person Gender Identity
Binding: MODS Person Gender Identity Code (required)
.... religion 1..1 Coding Person Religion
Binding: MODS Person Religion Code (required)
.... sexualOrientation 1..1 Coding Person Sexual Orientation
Binding: MODS Person Sexual Orientation Code (required)
.... firstLanguage 0..1 Coding Person First Language
Binding: AllLanguages (required)
.... otherLanguage 0..1 Coding Person Other Language
Binding: AllLanguages (required)
.... interpreterRequired 0..1 boolean Person Interpreter Required
.... immigrationStatus 0..1 string Person Immigration Status
.... primaryNationality 0..1 Coding Person Primary Nationality
Binding: MODS Country (required)
.... otherNationality 0..1 Coding Person Other Nationality
Binding: MODS Country (required)
.... pregnancyStatus 0..1 Coding Female Pregnancy Status
Binding: MODS Female Pregnancy Status (required)
.... pronouns 0..1 string Person Pronouns
.... addressEntry1 C 1..1 string First address line
Constraints: addressline-invariant
.... addressEntry2 C 0..1 string Second address line
Constraints: addressline-invariant
.... addressEntry3 C 0..1 string Third address line
Constraints: addressline-invariant
.... addressEntry4 C 0..1 string Fourth address line
Constraints: addressline-invariant
.... postCode C 1..1 string Address postal code
Constraints: addresspostcode-invariant
.... country 0..1 Coding Address Country
Binding: MODS Country (required)
... contactDetails 1..1 BackboneElement Person Contact Details
.... emailAddressDetails 0..* BackboneElement Person Contact Email Address Details
..... emailAddress C 1..1 string Email address
Constraints: emailaddress-invariant
..... preferredOrder 0..1 positiveInt 1 indicates the preferred choice. Empty/not present indicates no preference.
..... type 1..1 Coding Contact Email address type
Binding: MODS Email Address Type (required)
.... telephoneDetails 0..* BackboneElement Person Contact Telephone Number Details
..... telephoneNumber C 1..1 string Telephone Number
Constraints: telephonenumber-invariant
..... preferredOrder 0..1 positiveInt 1 indicates the preferred choice. Empty/not present indicates no preference.
..... type 1..1 Coding Contact Telephone Number type
Binding: MODS Person Telephone Number Type Code (required)
... deathDetails 0..1 BackboneElement Person Death Details
.... deathCauseIdentificationMethod 0..1 Coding Death Cause Identification Method
Binding: MODS Death Cause Identification Method Code (required)
.... deathLocationType 0..1 Coding Preferred Death Location Type
Binding: MODS Death Location Type Code (required)
.... deathNotAtPreferredLocationReason 0..1 Coding Death not at preferred location reason
Binding: MODS Death not at Preferred Location Reason Code (required)
.... personDeathDate C 0..1 dateTime Person Death Date
Constraints: birthdeathdate-invariant
.... personDeathTime C 0..1 time Person Time of Death
Constraints: deathtime-invariant
.... personAtRiskOfUnexpectedDeath 0..1 Coding Person at Risk of Unexpected Death
Binding: MODS Person At Risk Of Unexpected Death Indicator (required)
.... preferredDeathLocationDiscussedIndicator 0..1 Coding Preferred Death Location Discussed Indicator
Binding: MODS Person Preferred Location of Death Discussed Indicator (required)
... careProvider 0..* Reference(MODS Care Organisation) A provider organisation, registered with the Care Quality Commission to provide personal care and support to the Subject of care.
... generalPractice 0..1 Reference(MODS Care Organisation) Person's registered GP practice

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MODS-SubjectOfCare.identification.​nhsNumber.statusIndicator Base required NHS Number Verification Status 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​sex Base required MODS Person Sex (Birth Sex) Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​maritalStatus Base required MODS Person Marital Status Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​ethnicity Base required MODS Person Ethnicity Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​genderIdentity Base required MODS Person Gender Identity Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​religion Base required MODS Person Religion Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​sexualOrientation Base required MODS Person Sexual Orientation Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​firstLanguage Base required All Languages 📦4.0.1 FHIR Std.
MODS-SubjectOfCare.demographics.​otherLanguage Base required All Languages 📦4.0.1 FHIR Std.
MODS-SubjectOfCare.demographics.​primaryNationality Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​otherNationality Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​pregnancyStatus Base required MODS Female Pregnancy Status 📦0.1.0 This IG
MODS-SubjectOfCare.address.​country Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.contactDetails.​emailAddressDetails.​type Base required MODS Email Address Type 📦0.1.0 This IG
MODS-SubjectOfCare.contactDetails.​telephoneDetails.type Base required MODS Person Telephone Number Type Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathCauseIdentificationMethod Base required MODS Death Cause Identification Method Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathLocationType Base required MODS Death Location Type Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathNotAtPreferredLocationReason Base required MODS Death not at Preferred Location Reason Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​personAtRiskOfUnexpectedDeath Base required MODS Person At Risk Of Unexpected Death Indicator 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​preferredDeathLocationDiscussedIndicator Base required MODS Person Preferred Location of Death Discussed Indicator 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
addressline-invariant error MODS-SubjectOfCare.address.addressEntry1, MODS-SubjectOfCare.address.addressEntry2, MODS-SubjectOfCare.address.addressEntry3, MODS-SubjectOfCare.address.addressEntry4 Address lines MUST not exceed 35 characters in length $this.length() <= 35
addresspostcode-invariant error MODS-SubjectOfCare.address.postCode Only UK postcodes are valid $this.matches('^[a-zA-Z0-9]{0,8}$') and $this.length() <= 8
birthdeathdate-invariant error MODS-SubjectOfCare.demographics.dateOfBirth, MODS-SubjectOfCare.deathDetails.personDeathDate Subject of Care Birth and Death date MUST be represented as Dates (YYYY-MM-DD only) $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
deathtime-invariant error MODS-SubjectOfCare.deathDetails.personDeathTime Subject of Care Time of Death, in the format hh:mm:ss $this.matches('([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?')
emailaddress-invariant error MODS-SubjectOfCare.contactDetails.emailAddressDetails.emailAddress MUST be a valid email address $this.matches('[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$')
nhsnumber-invariant error MODS-SubjectOfCare.identification.nhsNumber.value 10-digit NHS Number (leading zeros allowed). MUST be exactly 10 digits (numeric only) $this.matches('^\d{10}$')
telephonenumber-invariant error MODS-SubjectOfCare.contactDetails.telephoneDetails.telephoneNumber Telephone Numbers MUST be valid UK land line or mobile number, contain digits only, and not exceed 35 characters length $this.matches('^(?:\+44\s?|0)(?:\s?\d){9,10}$') and $this.length() <= 35

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MODS-SubjectOfCare 0..* Element MODS Subject of Care

Elements defined in Ancestors:@id, extension
Instances of this logical model can be the target of a Reference
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... name 1..1 BackboneElement Person Name
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... family 1..1 string Person Family/Surname
.... given 1..1 string Person Given/Forename
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... nhsNumber 1..1 BackboneElement Person NHS Number
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value C 1..1 string NHS Number
Constraints: nhsnumber-invariant
..... statusIndicator 1..1 Coding NHS Number Trace Status Indicator
Binding: NHS Number Verification Status (required)
.... otherIdentifier 0..* BackboneElement Person Other Identifier
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value 1..1 string Identifier Value
..... system 1..1 url A URL indicating the identifier’s system or type, used as a logical business identifier rather than a database key.
... demographics 1..1 BackboneElement Person Demographics
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dateOfBirth C 1..1 dateTime Date Of Birth
Constraints: birthdeathdate-invariant
.... sex 1..1 Coding Person Sex
Binding: MODS Person Sex (Birth Sex) Code (required)
.... maritalStatus 1..1 Coding Person Marital Status
Binding: MODS Person Marital Status Code (required)
.... ethnicity 1..1 Coding Person Ethnicity
Binding: MODS Person Ethnicity Code (required)
.... genderIdentity 1..1 Coding Person Gender Identity
Binding: MODS Person Gender Identity Code (required)
.... religion 1..1 Coding Person Religion
Binding: MODS Person Religion Code (required)
.... sexualOrientation 1..1 Coding Person Sexual Orientation
Binding: MODS Person Sexual Orientation Code (required)
.... firstLanguage 0..1 Coding Person First Language
Binding: AllLanguages (required)
.... otherLanguage 0..1 Coding Person Other Language
Binding: AllLanguages (required)
.... interpreterRequired 0..1 boolean Person Interpreter Required
.... immigrationStatus 0..1 string Person Immigration Status
.... primaryNationality 0..1 Coding Person Primary Nationality
Binding: MODS Country (required)
.... otherNationality 0..1 Coding Person Other Nationality
Binding: MODS Country (required)
.... pregnancyStatus 0..1 Coding Female Pregnancy Status
Binding: MODS Female Pregnancy Status (required)
.... pronouns 0..1 string Person Pronouns
... address 1..* BackboneElement Person Address
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... addressEntry1 C 1..1 string First address line
Constraints: addressline-invariant
.... addressEntry2 C 0..1 string Second address line
Constraints: addressline-invariant
.... addressEntry3 C 0..1 string Third address line
Constraints: addressline-invariant
.... addressEntry4 C 0..1 string Fourth address line
Constraints: addressline-invariant
.... postCode C 1..1 string Address postal code
Constraints: addresspostcode-invariant
.... country 0..1 Coding Address Country
Binding: MODS Country (required)
... contactDetails 1..1 BackboneElement Person Contact Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... emailAddressDetails 0..* BackboneElement Person Contact Email Address Details
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... emailAddress C 1..1 string Email address
Constraints: emailaddress-invariant
..... preferredOrder 0..1 positiveInt 1 indicates the preferred choice. Empty/not present indicates no preference.
..... type 1..1 Coding Contact Email address type
Binding: MODS Email Address Type (required)
.... telephoneDetails 0..* BackboneElement Person Contact Telephone Number Details
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... telephoneNumber C 1..1 string Telephone Number
Constraints: telephonenumber-invariant
..... preferredOrder 0..1 positiveInt 1 indicates the preferred choice. Empty/not present indicates no preference.
..... type 1..1 Coding Contact Telephone Number type
Binding: MODS Person Telephone Number Type Code (required)
... deathDetails 0..1 BackboneElement Person Death Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... deathCauseIdentificationMethod 0..1 Coding Death Cause Identification Method
Binding: MODS Death Cause Identification Method Code (required)
.... deathLocationType 0..1 Coding Preferred Death Location Type
Binding: MODS Death Location Type Code (required)
.... deathNotAtPreferredLocationReason 0..1 Coding Death not at preferred location reason
Binding: MODS Death not at Preferred Location Reason Code (required)
.... personDeathDate C 0..1 dateTime Person Death Date
Constraints: birthdeathdate-invariant
.... personDeathTime C 0..1 time Person Time of Death
Constraints: deathtime-invariant
.... personAtRiskOfUnexpectedDeath 0..1 Coding Person at Risk of Unexpected Death
Binding: MODS Person At Risk Of Unexpected Death Indicator (required)
.... preferredDeathLocationDiscussedIndicator 0..1 Coding Preferred Death Location Discussed Indicator
Binding: MODS Person Preferred Location of Death Discussed Indicator (required)
... careProvider 0..* Reference(MODS Care Organisation) A provider organisation, registered with the Care Quality Commission to provide personal care and support to the Subject of care.
... generalPractice 0..1 Reference(MODS Care Organisation) Person's registered GP practice

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MODS-SubjectOfCare.identification.​nhsNumber.statusIndicator Base required NHS Number Verification Status 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​sex Base required MODS Person Sex (Birth Sex) Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​maritalStatus Base required MODS Person Marital Status Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​ethnicity Base required MODS Person Ethnicity Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​genderIdentity Base required MODS Person Gender Identity Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​religion Base required MODS Person Religion Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​sexualOrientation Base required MODS Person Sexual Orientation Code 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​firstLanguage Base required All Languages 📦4.0.1 FHIR Std.
MODS-SubjectOfCare.demographics.​otherLanguage Base required All Languages 📦4.0.1 FHIR Std.
MODS-SubjectOfCare.demographics.​primaryNationality Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​otherNationality Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.demographics.​pregnancyStatus Base required MODS Female Pregnancy Status 📦0.1.0 This IG
MODS-SubjectOfCare.address.​country Base required MODS Country 📦0.1.0 This IG
MODS-SubjectOfCare.contactDetails.​emailAddressDetails.​type Base required MODS Email Address Type 📦0.1.0 This IG
MODS-SubjectOfCare.contactDetails.​telephoneDetails.type Base required MODS Person Telephone Number Type Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathCauseIdentificationMethod Base required MODS Death Cause Identification Method Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathLocationType Base required MODS Death Location Type Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​deathNotAtPreferredLocationReason Base required MODS Death not at Preferred Location Reason Code 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​personAtRiskOfUnexpectedDeath Base required MODS Person At Risk Of Unexpected Death Indicator 📦0.1.0 This IG
MODS-SubjectOfCare.deathDetails.​preferredDeathLocationDiscussedIndicator Base required MODS Person Preferred Location of Death Discussed Indicator 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
addressline-invariant error MODS-SubjectOfCare.address.addressEntry1, MODS-SubjectOfCare.address.addressEntry2, MODS-SubjectOfCare.address.addressEntry3, MODS-SubjectOfCare.address.addressEntry4 Address lines MUST not exceed 35 characters in length $this.length() <= 35
addresspostcode-invariant error MODS-SubjectOfCare.address.postCode Only UK postcodes are valid $this.matches('^[a-zA-Z0-9]{0,8}$') and $this.length() <= 8
birthdeathdate-invariant error MODS-SubjectOfCare.demographics.dateOfBirth, MODS-SubjectOfCare.deathDetails.personDeathDate Subject of Care Birth and Death date MUST be represented as Dates (YYYY-MM-DD only) $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
deathtime-invariant error MODS-SubjectOfCare.deathDetails.personDeathTime Subject of Care Time of Death, in the format hh:mm:ss $this.matches('([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
emailaddress-invariant error MODS-SubjectOfCare.contactDetails.emailAddressDetails.emailAddress MUST be a valid email address $this.matches('[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$')
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nhsnumber-invariant error MODS-SubjectOfCare.identification.nhsNumber.value 10-digit NHS Number (leading zeros allowed). MUST be exactly 10 digits (numeric only) $this.matches('^\d{10}$')
telephonenumber-invariant error MODS-SubjectOfCare.contactDetails.telephoneDetails.telephoneNumber Telephone Numbers MUST be valid UK land line or mobile number, contain digits only, and not exceed 35 characters length $this.matches('^(?:\+44\s?|0)(?:\s?\d){9,10}$') and $this.length() <= 35

This structure is derived from Element

Summary

Mandatory: 0 element(25 nested mandatory elements)

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel