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 Transfer
| Official URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Transfer | Version: 0.1.0 | |||
| Draft as of 2026-03-24 | Computable Name: MODSTransfer | |||
MODS Definition: A model for cross‑provider subject of care data transfer workflow between DSCR systems
Usages:
- This Logical Model is not used by any profiles in this Implementation Guide
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-Transfer |
0..* | Element | MODS Transfer 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 | |
  requestor |
1..1 | BackboneElement | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
 @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 |
 organisation |
1..1 | Reference(MODS Care Organisation) | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
 contact |
1..1 | Reference(MODS Care Worker) | The person who is the point of contact at for this request at the requesting organisation. | |
| fulfiller |
1..1 | BackboneElement | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
| @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 |
| organisation |
1..1 | Reference(MODS Care Organisation) | The Care Provider Organisation fulfilling the transfer. | |
| contact |
0..1 | Reference(MODS Care Worker) | The person who is the point of contact at for this request at the requesting organisation. | |
| subject |
1..1 | BackboneElement | The name and NHS Number of the person that is the subject of the data transfer (Subject of Care) | |
| @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 |
| 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 | |
 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) | |
| targetCompletionDate |
0..1 | dateTime | The preferred date on which the requestor would like the transfer to be completed | |
| tracking |
1..1 | BackboneElement | Transfer tracking information | |
| @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 |
| progress |
1..1 | BackboneElement | Captures the current/last recorded status of the transfer | |
| @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 |
| status |
1..1 | Coding | Captures the current/last recorded status of the transfer Binding: MODS Transfer Tracking Status Code (required) | |
| date |
1..1 | dateTime | Date/Time the status was changed | |
| requestorTrackingId |
1..1 | string | Requestor tracking number/reference number. MUST be a stable, unique identifier. Can be the same value as the Id property | |
| fulfillerTrackingId |
0..1 | string | Optional fulfiller tracking number/reference number. MUST be a stable, unique identifier | |
| notes |
0..* | BackboneElement | Comments, notes or messages related to a transfer request and used to convey information about the status of the transfer request. Notes can be made, and read, by either the transfer requestor or fulfiller | |
| @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 |
| date |
1..1 | dateTime | When the note was made | |
| text |
1..1 | string | The note content (text) | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-Transfer.subject.nhsNumber.statusIndicator | Base | required | NHS Number Verification Status | 📦0.1.0 | This IG |
| MODS-Transfer.tracking.progress.status | Base | required | MODS Transfer Tracking Status Code | 📦0.1.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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-Transfer.subject.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-Transfer |
0..* | Element | MODS Transfer Elements defined in Ancestors:@id, extension Instances of this logical model can be the target of a Reference | |
| requestor |
1..1 | BackboneElement | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
| organisation |
1..1 | Reference(MODS Care Organisation) | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
| contact |
1..1 | Reference(MODS Care Worker) | The person who is the point of contact at for this request at the requesting organisation. | |
| fulfiller |
1..1 | BackboneElement | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
| organisation |
1..1 | Reference(MODS Care Organisation) | The Care Provider Organisation fulfilling the transfer. | |
| contact |
0..1 | Reference(MODS Care Worker) | The person who is the point of contact at for this request at the requesting organisation. | |
| subject |
1..1 | BackboneElement | The name and NHS Number of the person that is the subject of the data transfer (Subject of Care) | |
| name |
1..1 | BackboneElement | Person Name | |
| family |
1..1 | string | Person Family/Surname | |
| given |
1..1 | string | Person Given/Forename | |
| 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) | |
| targetCompletionDate |
0..1 | dateTime | The preferred date on which the requestor would like the transfer to be completed | |
| tracking |
1..1 | BackboneElement | Transfer tracking information | |
| progress |
1..1 | BackboneElement | Captures the current/last recorded status of the transfer | |
| status |
1..1 | Coding | Captures the current/last recorded status of the transfer Binding: MODS Transfer Tracking Status Code (required) | |
| date |
1..1 | dateTime | Date/Time the status was changed | |
| requestorTrackingId |
1..1 | string | Requestor tracking number/reference number. MUST be a stable, unique identifier. Can be the same value as the Id property | |
| fulfillerTrackingId |
0..1 | string | Optional fulfiller tracking number/reference number. MUST be a stable, unique identifier | |
| notes |
0..* | BackboneElement | Comments, notes or messages related to a transfer request and used to convey information about the status of the transfer request. Notes can be made, and read, by either the transfer requestor or fulfiller | |
| date |
1..1 | dateTime | When the note was made | |
| text |
1..1 | string | The note content (text) | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-Transfer.subject.nhsNumber.statusIndicator | Base | required | NHS Number Verification Status | 📦0.1.0 | This IG |
| MODS-Transfer.tracking.progress.status | Base | required | MODS Transfer Tracking Status Code | 📦0.1.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| nhsnumber-invariant | error | MODS-Transfer.subject.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-Transfer |
0..* | Element | MODS Transfer 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 | |
| requestor |
1..1 | BackboneElement | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
| @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 |
| organisation |
1..1 | Reference(MODS Care Organisation) | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
| contact |
1..1 | Reference(MODS Care Worker) | The person who is the point of contact at for this request at the requesting organisation. | |
| fulfiller |
1..1 | BackboneElement | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
| @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 |
| organisation |
1..1 | Reference(MODS Care Organisation) | The Care Provider Organisation fulfilling the transfer. | |
| contact |
0..1 | Reference(MODS Care Worker) | The person who is the point of contact at for this request at the requesting organisation. | |
| subject |
1..1 | BackboneElement | The name and NHS Number of the person that is the subject of the data transfer (Subject of Care) | |
| @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 |
| 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 | |
| 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) | |
| targetCompletionDate |
0..1 | dateTime | The preferred date on which the requestor would like the transfer to be completed | |
| tracking |
1..1 | BackboneElement | Transfer tracking information | |
| @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 |
| progress |
1..1 | BackboneElement | Captures the current/last recorded status of the transfer | |
| @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 |
| status |
1..1 | Coding | Captures the current/last recorded status of the transfer Binding: MODS Transfer Tracking Status Code (required) | |
| date |
1..1 | dateTime | Date/Time the status was changed | |
| requestorTrackingId |
1..1 | string | Requestor tracking number/reference number. MUST be a stable, unique identifier. Can be the same value as the Id property | |
| fulfillerTrackingId |
0..1 | string | Optional fulfiller tracking number/reference number. MUST be a stable, unique identifier | |
| notes |
0..* | BackboneElement | Comments, notes or messages related to a transfer request and used to convey information about the status of the transfer request. Notes can be made, and read, by either the transfer requestor or fulfiller | |
| @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 |
| date |
1..1 | dateTime | When the note was made | |
| text |
1..1 | string | The note content (text) | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-Transfer.subject.nhsNumber.statusIndicator | Base | required | NHS Number Verification Status | 📦0.1.0 | This IG |
| MODS-Transfer.tracking.progress.status | Base | required | MODS Transfer Tracking Status Code | 📦0.1.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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-Transfer.subject.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-Transfer |
0..* | Element | MODS Transfer 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 | |
| requestor |
1..1 | BackboneElement | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
| @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 |
| organisation |
1..1 | Reference(MODS Care Organisation) | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
| contact |
1..1 | Reference(MODS Care Worker) | The person who is the point of contact at for this request at the requesting organisation. | |
| fulfiller |
1..1 | BackboneElement | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
| @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 |
| organisation |
1..1 | Reference(MODS Care Organisation) | The Care Provider Organisation fulfilling the transfer. | |
| contact |
0..1 | Reference(MODS Care Worker) | The person who is the point of contact at for this request at the requesting organisation. | |
| subject |
1..1 | BackboneElement | The name and NHS Number of the person that is the subject of the data transfer (Subject of Care) | |
| @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 |
| 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 | |
| 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) | |
| targetCompletionDate |
0..1 | dateTime | The preferred date on which the requestor would like the transfer to be completed | |
| tracking |
1..1 | BackboneElement | Transfer tracking information | |
| @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 |
| progress |
1..1 | BackboneElement | Captures the current/last recorded status of the transfer | |
| @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 |
| status |
1..1 | Coding | Captures the current/last recorded status of the transfer Binding: MODS Transfer Tracking Status Code (required) | |
| date |
1..1 | dateTime | Date/Time the status was changed | |
| requestorTrackingId |
1..1 | string | Requestor tracking number/reference number. MUST be a stable, unique identifier. Can be the same value as the Id property | |
| fulfillerTrackingId |
0..1 | string | Optional fulfiller tracking number/reference number. MUST be a stable, unique identifier | |
| notes |
0..* | BackboneElement | Comments, notes or messages related to a transfer request and used to convey information about the status of the transfer request. Notes can be made, and read, by either the transfer requestor or fulfiller | |
| @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 |
| date |
1..1 | dateTime | When the note was made | |
| text |
1..1 | string | The note content (text) | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-Transfer.subject.nhsNumber.statusIndicator | Base | required | NHS Number Verification Status | 📦0.1.0 | This IG |
| MODS-Transfer.tracking.progress.status | Base | required | MODS Transfer Tracking Status Code | 📦0.1.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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-Transfer.subject.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-Transfer |
0..* | Element | MODS Transfer Elements defined in Ancestors:@id, extension Instances of this logical model can be the target of a Reference | |
| requestor |
1..1 | BackboneElement | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
| organisation |
1..1 | Reference(MODS Care Organisation) | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
| contact |
1..1 | Reference(MODS Care Worker) | The person who is the point of contact at for this request at the requesting organisation. | |
| fulfiller |
1..1 | BackboneElement | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
| organisation |
1..1 | Reference(MODS Care Organisation) | The Care Provider Organisation fulfilling the transfer. | |
| contact |
0..1 | Reference(MODS Care Worker) | The person who is the point of contact at for this request at the requesting organisation. | |
| subject |
1..1 | BackboneElement | The name and NHS Number of the person that is the subject of the data transfer (Subject of Care) | |
| name |
1..1 | BackboneElement | Person Name | |
| family |
1..1 | string | Person Family/Surname | |
| given |
1..1 | string | Person Given/Forename | |
| 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) | |
| targetCompletionDate |
0..1 | dateTime | The preferred date on which the requestor would like the transfer to be completed | |
| tracking |
1..1 | BackboneElement | Transfer tracking information | |
| progress |
1..1 | BackboneElement | Captures the current/last recorded status of the transfer | |
| status |
1..1 | Coding | Captures the current/last recorded status of the transfer Binding: MODS Transfer Tracking Status Code (required) | |
| date |
1..1 | dateTime | Date/Time the status was changed | |
| requestorTrackingId |
1..1 | string | Requestor tracking number/reference number. MUST be a stable, unique identifier. Can be the same value as the Id property | |
| fulfillerTrackingId |
0..1 | string | Optional fulfiller tracking number/reference number. MUST be a stable, unique identifier | |
| notes |
0..* | BackboneElement | Comments, notes or messages related to a transfer request and used to convey information about the status of the transfer request. Notes can be made, and read, by either the transfer requestor or fulfiller | |
| date |
1..1 | dateTime | When the note was made | |
| text |
1..1 | string | The note content (text) | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-Transfer.subject.nhsNumber.statusIndicator | Base | required | NHS Number Verification Status | 📦0.1.0 | This IG |
| MODS-Transfer.tracking.progress.status | Base | required | MODS Transfer Tracking Status Code | 📦0.1.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| nhsnumber-invariant | error | MODS-Transfer.subject.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-Transfer |
0..* | Element | MODS Transfer 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 | |
| requestor |
1..1 | BackboneElement | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
| @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 |
| organisation |
1..1 | Reference(MODS Care Organisation) | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
| contact |
1..1 | Reference(MODS Care Worker) | The person who is the point of contact at for this request at the requesting organisation. | |
| fulfiller |
1..1 | BackboneElement | Organisation and Named person involved in the requesting and fulfillment of a DSCR Transfer | |
| @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 |
| organisation |
1..1 | Reference(MODS Care Organisation) | The Care Provider Organisation fulfilling the transfer. | |
| contact |
0..1 | Reference(MODS Care Worker) | The person who is the point of contact at for this request at the requesting organisation. | |
| subject |
1..1 | BackboneElement | The name and NHS Number of the person that is the subject of the data transfer (Subject of Care) | |
| @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 |
| 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 | |
| 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) | |
| targetCompletionDate |
0..1 | dateTime | The preferred date on which the requestor would like the transfer to be completed | |
| tracking |
1..1 | BackboneElement | Transfer tracking information | |
| @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 |
| progress |
1..1 | BackboneElement | Captures the current/last recorded status of the transfer | |
| @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 |
| status |
1..1 | Coding | Captures the current/last recorded status of the transfer Binding: MODS Transfer Tracking Status Code (required) | |
| date |
1..1 | dateTime | Date/Time the status was changed | |
| requestorTrackingId |
1..1 | string | Requestor tracking number/reference number. MUST be a stable, unique identifier. Can be the same value as the Id property | |
| fulfillerTrackingId |
0..1 | string | Optional fulfiller tracking number/reference number. MUST be a stable, unique identifier | |
| notes |
0..* | BackboneElement | Comments, notes or messages related to a transfer request and used to convey information about the status of the transfer request. Notes can be made, and read, by either the transfer requestor or fulfiller | |
| @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 |
| date |
1..1 | dateTime | When the note was made | |
| text |
1..1 | string | The note content (text) | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-Transfer.subject.nhsNumber.statusIndicator | Base | required | NHS Number Verification Status | 📦0.1.0 | This IG |
| MODS-Transfer.tracking.progress.status | Base | required | MODS Transfer Tracking Status Code | 📦0.1.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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-Transfer.subject.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