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 Registration
| Official URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-SubjectOfCareRegistration | Version: 0.1.0 | |||
| Draft as of 2026-06-10 | Computable Name: MODSSubjectOfCareRegistration | |||
MODS Definition: Represents the input payload required to trace an NHS number and register a subject of care in the local Care Data Repository (CDR). This object contains core demographic details (such as name, date of birth, gender and home address) to assist with the trace process. It is intended for use with the /care-actors/subjects-of-care/register endpoint and must include all required fields to successfully perform the trace and create the patient record in the CDR.
Usages:
- This Logical Model is not used by any profiles in this Specification
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.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  MODS-SubjectOfCareRegistration |
0..* | Element | MODS Subject of Care Registration 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 | |
| subjectOfCareId |
1..1 | string | Unique record id for the Subject of Care for whom registration was requested | |
  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 | |
| sex |
1..1 | Coding | Person Sex Binding: MODS Person Sex (Birth Sex) Code (required) | |
| ethnicity |
1..1 | Coding | Person Ethnicity Binding: MODS Person Ethnicity Code (required) | |
| maritalStatus |
1..1 | Coding | Person Marital Status Binding: MODS Person Marital Status 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) | |
| dateOfBirth |
1..1 | dateTime | Date Of Birth | |
| homeAddress |
1..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) | |
| nhsNumber |
0..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 | 0..1 | string | NHS Number Constraints: nhsnumber-invariant |
| statusIndicator |
0..1 | Coding | NHS Number Trace Status Indicator Binding: NHS Number Verification Status (required) | |
| nationalInsuranceNumber |
0..1 | string | NI Number | |
 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. | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-SubjectOfCareRegistration.sex | Base | required | MODS Person Sex (Birth Sex) Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.ethnicity | Base | required | MODS Person Ethnicity Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.maritalStatus | Base | required | MODS Person Marital Status Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.religion | Base | required | MODS Person Religion Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.sexualOrientation | Base | required | MODS Person Sexual Orientation Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.homeAddress.country | Base | required | MODS Country | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.nhsNumber.statusIndicator | Base | required | NHS Number Verification Status | 📦0.1.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| addressline-invariant | error | MODS-SubjectOfCareRegistration.homeAddress.addressEntry1, MODS-SubjectOfCareRegistration.homeAddress.addressEntry2, MODS-SubjectOfCareRegistration.homeAddress.addressEntry3, MODS-SubjectOfCareRegistration.homeAddress.addressEntry4 | Address lines MUST not exceed 35 characters in length |
$this.length() <= 35
|
| addresspostcode-invariant | error | MODS-SubjectOfCareRegistration.homeAddress.postCode | Only UK postcodes are valid |
$this.matches('^[a-zA-Z0-9]{0,8}$') and $this.length() <= 8
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| nhsnumber-invariant | error | MODS-SubjectOfCareRegistration.nhsNumber.value | 10-digit NHS Number (leading zeros allowed). MUST be exactly 10 digits (numeric only) |
$this.matches('^\d{10}$')
|
This structure is derived from Element
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MODS-SubjectOfCareRegistration |
0..* | Element | MODS Subject of Care Registration Elements defined in Ancestors:@id, extension Instances of this logical model can be the target of a Reference | |
| subjectOfCareId |
1..1 | string | Unique record id for the Subject of Care for whom registration was requested | |
| name |
1..1 | BackboneElement | Person Name | |
| family |
1..1 | string | Person Family/Surname | |
| given |
1..1 | string | Person Given/Forename | |
| sex |
1..1 | Coding | Person Sex Binding: MODS Person Sex (Birth Sex) Code (required) | |
| ethnicity |
1..1 | Coding | Person Ethnicity Binding: MODS Person Ethnicity Code (required) | |
| maritalStatus |
1..1 | Coding | Person Marital Status Binding: MODS Person Marital Status 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) | |
| dateOfBirth |
1..1 | dateTime | Date Of Birth | |
| homeAddress |
1..1 | BackboneElement | Person Address | |
| 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) | |
| nhsNumber |
0..1 | BackboneElement | Person NHS Number | |
| value |
C | 0..1 | string | NHS Number Constraints: nhsnumber-invariant |
| statusIndicator |
0..1 | Coding | NHS Number Trace Status Indicator Binding: NHS Number Verification Status (required) | |
| nationalInsuranceNumber |
0..1 | string | NI Number | |
| 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. | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-SubjectOfCareRegistration.sex | Base | required | MODS Person Sex (Birth Sex) Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.ethnicity | Base | required | MODS Person Ethnicity Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.maritalStatus | Base | required | MODS Person Marital Status Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.religion | Base | required | MODS Person Religion Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.sexualOrientation | Base | required | MODS Person Sexual Orientation Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.homeAddress.country | Base | required | MODS Country | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.nhsNumber.statusIndicator | Base | required | NHS Number Verification Status | 📦0.1.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| addressline-invariant | error | MODS-SubjectOfCareRegistration.homeAddress.addressEntry1, MODS-SubjectOfCareRegistration.homeAddress.addressEntry2, MODS-SubjectOfCareRegistration.homeAddress.addressEntry3, MODS-SubjectOfCareRegistration.homeAddress.addressEntry4 | Address lines MUST not exceed 35 characters in length |
$this.length() <= 35
|
| addresspostcode-invariant | error | MODS-SubjectOfCareRegistration.homeAddress.postCode | Only UK postcodes are valid |
$this.matches('^[a-zA-Z0-9]{0,8}$') and $this.length() <= 8
|
| nhsnumber-invariant | error | MODS-SubjectOfCareRegistration.nhsNumber.value | 10-digit NHS Number (leading zeros allowed). MUST be exactly 10 digits (numeric only) |
$this.matches('^\d{10}$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MODS-SubjectOfCareRegistration |
0..* | Element | MODS Subject of Care Registration 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 | |
| subjectOfCareId |
1..1 | string | Unique record id for the Subject of Care for whom registration was requested | |
| 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 | |
| sex |
1..1 | Coding | Person Sex Binding: MODS Person Sex (Birth Sex) Code (required) | |
| ethnicity |
1..1 | Coding | Person Ethnicity Binding: MODS Person Ethnicity Code (required) | |
| maritalStatus |
1..1 | Coding | Person Marital Status Binding: MODS Person Marital Status 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) | |
| dateOfBirth |
1..1 | dateTime | Date Of Birth | |
| homeAddress |
1..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) | |
| nhsNumber |
0..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 | 0..1 | string | NHS Number Constraints: nhsnumber-invariant |
| statusIndicator |
0..1 | Coding | NHS Number Trace Status Indicator Binding: NHS Number Verification Status (required) | |
| nationalInsuranceNumber |
0..1 | string | NI Number | |
| 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. | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-SubjectOfCareRegistration.sex | Base | required | MODS Person Sex (Birth Sex) Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.ethnicity | Base | required | MODS Person Ethnicity Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.maritalStatus | Base | required | MODS Person Marital Status Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.religion | Base | required | MODS Person Religion Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.sexualOrientation | Base | required | MODS Person Sexual Orientation Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.homeAddress.country | Base | required | MODS Country | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.nhsNumber.statusIndicator | Base | required | NHS Number Verification Status | 📦0.1.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| addressline-invariant | error | MODS-SubjectOfCareRegistration.homeAddress.addressEntry1, MODS-SubjectOfCareRegistration.homeAddress.addressEntry2, MODS-SubjectOfCareRegistration.homeAddress.addressEntry3, MODS-SubjectOfCareRegistration.homeAddress.addressEntry4 | Address lines MUST not exceed 35 characters in length |
$this.length() <= 35
|
| addresspostcode-invariant | error | MODS-SubjectOfCareRegistration.homeAddress.postCode | Only UK postcodes are valid |
$this.matches('^[a-zA-Z0-9]{0,8}$') and $this.length() <= 8
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| nhsnumber-invariant | error | MODS-SubjectOfCareRegistration.nhsNumber.value | 10-digit NHS Number (leading zeros allowed). MUST be exactly 10 digits (numeric only) |
$this.matches('^\d{10}$')
|
This structure is derived from Element
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MODS-SubjectOfCareRegistration |
0..* | Element | MODS Subject of Care Registration 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 | |
| subjectOfCareId |
1..1 | string | Unique record id for the Subject of Care for whom registration was requested | |
| 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 | |
| sex |
1..1 | Coding | Person Sex Binding: MODS Person Sex (Birth Sex) Code (required) | |
| ethnicity |
1..1 | Coding | Person Ethnicity Binding: MODS Person Ethnicity Code (required) | |
| maritalStatus |
1..1 | Coding | Person Marital Status Binding: MODS Person Marital Status 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) | |
| dateOfBirth |
1..1 | dateTime | Date Of Birth | |
| homeAddress |
1..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) | |
| nhsNumber |
0..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 | 0..1 | string | NHS Number Constraints: nhsnumber-invariant |
| statusIndicator |
0..1 | Coding | NHS Number Trace Status Indicator Binding: NHS Number Verification Status (required) | |
| nationalInsuranceNumber |
0..1 | string | NI Number | |
| 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. | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-SubjectOfCareRegistration.sex | Base | required | MODS Person Sex (Birth Sex) Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.ethnicity | Base | required | MODS Person Ethnicity Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.maritalStatus | Base | required | MODS Person Marital Status Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.religion | Base | required | MODS Person Religion Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.sexualOrientation | Base | required | MODS Person Sexual Orientation Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.homeAddress.country | Base | required | MODS Country | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.nhsNumber.statusIndicator | Base | required | NHS Number Verification Status | 📦0.1.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| addressline-invariant | error | MODS-SubjectOfCareRegistration.homeAddress.addressEntry1, MODS-SubjectOfCareRegistration.homeAddress.addressEntry2, MODS-SubjectOfCareRegistration.homeAddress.addressEntry3, MODS-SubjectOfCareRegistration.homeAddress.addressEntry4 | Address lines MUST not exceed 35 characters in length |
$this.length() <= 35
|
| addresspostcode-invariant | error | MODS-SubjectOfCareRegistration.homeAddress.postCode | Only UK postcodes are valid |
$this.matches('^[a-zA-Z0-9]{0,8}$') and $this.length() <= 8
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| nhsnumber-invariant | error | MODS-SubjectOfCareRegistration.nhsNumber.value | 10-digit NHS Number (leading zeros allowed). MUST be exactly 10 digits (numeric only) |
$this.matches('^\d{10}$')
|
Differential View
This structure is derived from Element
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MODS-SubjectOfCareRegistration |
0..* | Element | MODS Subject of Care Registration Elements defined in Ancestors:@id, extension Instances of this logical model can be the target of a Reference | |
| subjectOfCareId |
1..1 | string | Unique record id for the Subject of Care for whom registration was requested | |
| name |
1..1 | BackboneElement | Person Name | |
| family |
1..1 | string | Person Family/Surname | |
| given |
1..1 | string | Person Given/Forename | |
| sex |
1..1 | Coding | Person Sex Binding: MODS Person Sex (Birth Sex) Code (required) | |
| ethnicity |
1..1 | Coding | Person Ethnicity Binding: MODS Person Ethnicity Code (required) | |
| maritalStatus |
1..1 | Coding | Person Marital Status Binding: MODS Person Marital Status 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) | |
| dateOfBirth |
1..1 | dateTime | Date Of Birth | |
| homeAddress |
1..1 | BackboneElement | Person Address | |
| 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) | |
| nhsNumber |
0..1 | BackboneElement | Person NHS Number | |
| value |
C | 0..1 | string | NHS Number Constraints: nhsnumber-invariant |
| statusIndicator |
0..1 | Coding | NHS Number Trace Status Indicator Binding: NHS Number Verification Status (required) | |
| nationalInsuranceNumber |
0..1 | string | NI Number | |
| 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. | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-SubjectOfCareRegistration.sex | Base | required | MODS Person Sex (Birth Sex) Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.ethnicity | Base | required | MODS Person Ethnicity Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.maritalStatus | Base | required | MODS Person Marital Status Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.religion | Base | required | MODS Person Religion Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.sexualOrientation | Base | required | MODS Person Sexual Orientation Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.homeAddress.country | Base | required | MODS Country | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.nhsNumber.statusIndicator | Base | required | NHS Number Verification Status | 📦0.1.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| addressline-invariant | error | MODS-SubjectOfCareRegistration.homeAddress.addressEntry1, MODS-SubjectOfCareRegistration.homeAddress.addressEntry2, MODS-SubjectOfCareRegistration.homeAddress.addressEntry3, MODS-SubjectOfCareRegistration.homeAddress.addressEntry4 | Address lines MUST not exceed 35 characters in length |
$this.length() <= 35
|
| addresspostcode-invariant | error | MODS-SubjectOfCareRegistration.homeAddress.postCode | Only UK postcodes are valid |
$this.matches('^[a-zA-Z0-9]{0,8}$') and $this.length() <= 8
|
| nhsnumber-invariant | error | MODS-SubjectOfCareRegistration.nhsNumber.value | 10-digit NHS Number (leading zeros allowed). MUST be exactly 10 digits (numeric only) |
$this.matches('^\d{10}$')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MODS-SubjectOfCareRegistration |
0..* | Element | MODS Subject of Care Registration 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 | |
| subjectOfCareId |
1..1 | string | Unique record id for the Subject of Care for whom registration was requested | |
| 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 | |
| sex |
1..1 | Coding | Person Sex Binding: MODS Person Sex (Birth Sex) Code (required) | |
| ethnicity |
1..1 | Coding | Person Ethnicity Binding: MODS Person Ethnicity Code (required) | |
| maritalStatus |
1..1 | Coding | Person Marital Status Binding: MODS Person Marital Status 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) | |
| dateOfBirth |
1..1 | dateTime | Date Of Birth | |
| homeAddress |
1..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) | |
| nhsNumber |
0..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 | 0..1 | string | NHS Number Constraints: nhsnumber-invariant |
| statusIndicator |
0..1 | Coding | NHS Number Trace Status Indicator Binding: NHS Number Verification Status (required) | |
| nationalInsuranceNumber |
0..1 | string | NI Number | |
| 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. | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-SubjectOfCareRegistration.sex | Base | required | MODS Person Sex (Birth Sex) Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.ethnicity | Base | required | MODS Person Ethnicity Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.maritalStatus | Base | required | MODS Person Marital Status Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.religion | Base | required | MODS Person Religion Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.sexualOrientation | Base | required | MODS Person Sexual Orientation Code | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.homeAddress.country | Base | required | MODS Country | 📦0.1.0 | This IG |
| MODS-SubjectOfCareRegistration.nhsNumber.statusIndicator | Base | required | NHS Number Verification Status | 📦0.1.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| addressline-invariant | error | MODS-SubjectOfCareRegistration.homeAddress.addressEntry1, MODS-SubjectOfCareRegistration.homeAddress.addressEntry2, MODS-SubjectOfCareRegistration.homeAddress.addressEntry3, MODS-SubjectOfCareRegistration.homeAddress.addressEntry4 | Address lines MUST not exceed 35 characters in length |
$this.length() <= 35
|
| addresspostcode-invariant | error | MODS-SubjectOfCareRegistration.homeAddress.postCode | Only UK postcodes are valid |
$this.matches('^[a-zA-Z0-9]{0,8}$') and $this.length() <= 8
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| nhsnumber-invariant | error | MODS-SubjectOfCareRegistration.nhsNumber.value | 10-digit NHS Number (leading zeros allowed). MUST be exactly 10 digits (numeric only) |
$this.matches('^\d{10}$')
|
This structure is derived from Element