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
| Official URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-RegistrationStatus | Version: 0.1.0 | |||
| Draft as of 2026-06-10 | Computable Name: MODSRegistrationStatus | |||
MODS Definition: The result of a registration operation. This response contains the identifier of the Subject of Care for whom registration was requested, along with the current registration status and a timestamp. If the registration operation fails, a reason will be provided. Registration is processed asynchronously, and clients should poll the registration status endpoint at intervals to obtain an updated or terminal status. For new registrations, an initial status of pending is returned.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Element | MODS Registration Status Elements defined in Ancestors:@id, extension Instances of this logical model can be the target of a Reference | |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() |
1..1 | string | Unique record id for the Subject of Care for whom registration was requested | |
![]() ![]() |
1..1 | code | Status Binding: MODS Registration Status (required) | |
![]() ![]() |
0..1 | string | A reason explaining any status. Always present for error or failed status codes. | |
![]() ![]() |
0..1 | string | Error or failure responses may include diagnostic information to provide additional context and explanation for the reported status | |
![]() ![]() |
1..1 | dateTime | The most recent available date time the registration status was updated | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-RegistrationStatus.status | Base | required | MODS Registration Status | 📦0.1.0 | This IG |
| 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()
|
This structure is derived from Element
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Element | MODS Registration Status Elements defined in Ancestors:@id, extension Instances of this logical model can be the target of a Reference | |
![]() ![]() |
1..1 | string | Unique record id for the Subject of Care for whom registration was requested | |
![]() ![]() |
1..1 | code | Status Binding: MODS Registration Status (required) | |
![]() ![]() |
0..1 | string | A reason explaining any status. Always present for error or failed status codes. | |
![]() ![]() |
0..1 | string | Error or failure responses may include diagnostic information to provide additional context and explanation for the reported status | |
![]() ![]() |
1..1 | dateTime | The most recent available date time the registration status was updated | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-RegistrationStatus.status | Base | required | MODS Registration Status | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Element | MODS Registration Status Elements defined in Ancestors:@id, extension Instances of this logical model can be the target of a Reference | |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() |
1..1 | string | Unique record id for the Subject of Care for whom registration was requested | |
![]() ![]() |
1..1 | code | Status Binding: MODS Registration Status (required) | |
![]() ![]() |
0..1 | string | A reason explaining any status. Always present for error or failed status codes. | |
![]() ![]() |
0..1 | string | Error or failure responses may include diagnostic information to provide additional context and explanation for the reported status | |
![]() ![]() |
1..1 | dateTime | The most recent available date time the registration status was updated | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-RegistrationStatus.status | Base | required | MODS Registration Status | 📦0.1.0 | This IG |
| 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()
|
This structure is derived from Element
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Element | MODS Registration Status Elements defined in Ancestors:@id, extension Instances of this logical model can be the target of a Reference | |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() |
1..1 | string | Unique record id for the Subject of Care for whom registration was requested | |
![]() ![]() |
1..1 | code | Status Binding: MODS Registration Status (required) | |
![]() ![]() |
0..1 | string | A reason explaining any status. Always present for error or failed status codes. | |
![]() ![]() |
0..1 | string | Error or failure responses may include diagnostic information to provide additional context and explanation for the reported status | |
![]() ![]() |
1..1 | dateTime | The most recent available date time the registration status was updated | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-RegistrationStatus.status | Base | required | MODS Registration Status | 📦0.1.0 | This IG |
| 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()
|
Differential View
This structure is derived from Element
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Element | MODS Registration Status Elements defined in Ancestors:@id, extension Instances of this logical model can be the target of a Reference | |
![]() ![]() |
1..1 | string | Unique record id for the Subject of Care for whom registration was requested | |
![]() ![]() |
1..1 | code | Status Binding: MODS Registration Status (required) | |
![]() ![]() |
0..1 | string | A reason explaining any status. Always present for error or failed status codes. | |
![]() ![]() |
0..1 | string | Error or failure responses may include diagnostic information to provide additional context and explanation for the reported status | |
![]() ![]() |
1..1 | dateTime | The most recent available date time the registration status was updated | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-RegistrationStatus.status | Base | required | MODS Registration Status | 📦0.1.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Element | MODS Registration Status Elements defined in Ancestors:@id, extension Instances of this logical model can be the target of a Reference | |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() |
1..1 | string | Unique record id for the Subject of Care for whom registration was requested | |
![]() ![]() |
1..1 | code | Status Binding: MODS Registration Status (required) | |
![]() ![]() |
0..1 | string | A reason explaining any status. Always present for error or failed status codes. | |
![]() ![]() |
0..1 | string | Error or failure responses may include diagnostic information to provide additional context and explanation for the reported status | |
![]() ![]() |
1..1 | dateTime | The most recent available date time the registration status was updated | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MODS-RegistrationStatus.status | Base | required | MODS Registration Status | 📦0.1.0 | This IG |
| 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()
|
This structure is derived from Element