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
| Draft as of 2026-06-10 |
Definitions for the MODS-RegistrationStatus logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. MODS-RegistrationStatus | |
| Definition | 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. Base definition for all elements in a resource. |
| Short | MODS Registration StatusBase for all elements |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. MODS-RegistrationStatus.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 4. MODS-RegistrationStatus.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on MODS-RegistrationStatus.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. MODS-RegistrationStatus.subjectOfCareId | |
| Definition | Unique record id for the Subject of Care for whom registration was requested |
| Short | Unique record id for the Subject of Care for whom registration was requested |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. MODS-RegistrationStatus.status | |
| Definition | A status code indicating the outcome of the registration operation. |
| Short | Status |
| Control | 1..1 |
| Binding | The codes SHALL be taken from MODS Registration Status (required to https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-RegistrationStatus-1) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. MODS-RegistrationStatus.reason | |
| Definition | A reason explaining any status. Always present for error or failed status codes. |
| Short | A reason explaining any status. Always present for error or failed status codes. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. MODS-RegistrationStatus.diagnostics | |
| Definition | Error or failure responses may include diagnostic information to provide additional context and explanation for the reported status |
| Short | Error or failure responses may include diagnostic information to provide additional context and explanation for the reported status |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. MODS-RegistrationStatus.updatedAt | |
| Definition | The most recent available date time the registration status was updated |
| Short | The most recent available date time the registration status was updated |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. MODS-RegistrationStatus | |
| Definition | 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. |
| Short | MODS Registration Status |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. MODS-RegistrationStatus.subjectOfCareId | |
| Definition | Unique record id for the Subject of Care for whom registration was requested |
| Short | Unique record id for the Subject of Care for whom registration was requested |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. MODS-RegistrationStatus.status | |
| Definition | A status code indicating the outcome of the registration operation. |
| Short | Status |
| Control | 1..1 |
| Binding | The codes SHALL be taken from MODS Registration Status (required to https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-RegistrationStatus-1) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. MODS-RegistrationStatus.reason | |
| Definition | A reason explaining any status. Always present for error or failed status codes. |
| Short | A reason explaining any status. Always present for error or failed status codes. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. MODS-RegistrationStatus.diagnostics | |
| Definition | Error or failure responses may include diagnostic information to provide additional context and explanation for the reported status |
| Short | Error or failure responses may include diagnostic information to provide additional context and explanation for the reported status |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. MODS-RegistrationStatus.updatedAt | |
| Definition | The most recent available date time the registration status was updated |
| Short | The most recent available date time the registration status was updated |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. MODS-RegistrationStatus | |
| Definition | 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. |
| Short | MODS Registration Status |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. MODS-RegistrationStatus.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 4. MODS-RegistrationStatus.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on MODS-RegistrationStatus.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. MODS-RegistrationStatus.subjectOfCareId | |
| Definition | Unique record id for the Subject of Care for whom registration was requested |
| Short | Unique record id for the Subject of Care for whom registration was requested |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. MODS-RegistrationStatus.status | |
| Definition | A status code indicating the outcome of the registration operation. |
| Short | Status |
| Control | 1..1 |
| Binding | The codes SHALL be taken from MODS Registration Status (required to https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-RegistrationStatus-1) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. MODS-RegistrationStatus.reason | |
| Definition | A reason explaining any status. Always present for error or failed status codes. |
| Short | A reason explaining any status. Always present for error or failed status codes. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. MODS-RegistrationStatus.diagnostics | |
| Definition | Error or failure responses may include diagnostic information to provide additional context and explanation for the reported status |
| Short | Error or failure responses may include diagnostic information to provide additional context and explanation for the reported status |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. MODS-RegistrationStatus.updatedAt | |
| Definition | The most recent available date time the registration status was updated |
| Short | The most recent available date time the registration status was updated |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |