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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.
| MODS DSCR to DSCR transfer |
Transfers a patient from one organisation/service/care context to another. Invoked at the Patient type level because the fulfiller does not know the server-assigned Patient id. |
These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.
| MODS About Me |
MODS Definition: This is a record of the things that a person feels it is important to communicate about their needs, strengths, values, concerns and preferences to others providing support and care. |
| MODS Alert |
MODS Definition: Details of an alert, which should be determined locally. They might, for example, include the fact that the person has a dangerous dog. It is important that alerts are managed and removed when they are no longer relevant - e.g. 'the dangerous dog' alert if the dog is no longer present. |
| MODS Allergy |
MODS Definition: Details about the Subject of care's allergies or adverse reactions. |
| MODS Care Organisation |
MODS Definition: Organisation involved in providing care and support. |
| MODS Care Worker |
MODS Definition: Information about a care worker who provides care for the subject of care. Usually an employee of a provider, local authority, healthcare organisation or voluntary organisation. |
| MODS Daily Living |
MODS Definition: Observation of activities relating to personal care and mobility about the home that are basic to daily living. |
| MODS Education History |
MODS Definition: Details of the person's educational history. |
| MODS Need |
MODS Definition: All health and care needs, including emotional, social, cultural, religious and spiritual needs, should be included in assessments about the care and treatment people receive. |
| MODS Occupational History |
MODS Definition: The current and/or previous occupation(s) of the person. |
| MODS Proxy For Subject of Care |
MODS Definition: Health and social care third party having person role with the right to take decisions on behalf of the subject of care. |
| MODS Registration Status |
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. |
| MODS Risk |
MODS Definition: Risks identified as part of a risk assessment. |
| MODS Safeguarding |
MODS Definition: Identified safeguarding concerns protecting vulnerable people from neglect or physical, financial, psychological, verbal or other forms of abuse. Implementation guidance: It is recognised that local authorities may not record the details of safeguarding concerns as a matter of policy. In such scenarios, health and social care organisations enquiring about a safeguarding flag may be directed to the local Multi-Agency Safeguarding Hub (MASH) team. |
| MODS Social Circumstance |
MODS Definition: Details of the persons social circumstances |
| MODS Subject of Care |
MODS Definition: A person who seeks to receive, is receiving, or has received care. |
| MODS Subject of Care Registration |
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. |
| MODS Trace |
MODS Definition: Represents the response returned from an NHS number trace request. The response includes the verified NHS Number along with the core demographic and registration details associated with the individual. |
| MODS Transfer |
MODS Definition: A model for cross‑provider subject of care data transfer workflow between DSCR systems |
| MODS Wish |
MODS Definition: A record of a person's aspirations and a description of things they want someone supporting them to do (or not to do) |
These define constraints on FHIR resources for systems conforming to this implementation guide.
| MODS About Me Observation |
Observation capturing About Me preferences/information using up to eight sections. |
| MODS Activity Task |
Defines a single activity within an Instruction, such as a medication administration. |
| MODS Allergy Intolerance |
This profile defines the MODS constraints and extensions on the HL7 UK Core FHIR AllergyIntolerance resource AllergyIntolerance |
| MODS Care Needs Assessment Observation |
Local authorities must carry out an assessment of anyone who appears to require care and support. The aim of assessment is to understand the person's needs and goals. |
| MODS Care Plan |
This records the decisions reached during conversation between the individual and health and care professional about future plans and also records progress |
| MODS Care Team |
Care actors who perform an activity or performed the action or made an observation |
| MODS Condition |
This profile defines the MODS constraints and extensions on the HL7 UK Core FHIR Condition resource Condition |
| MODS DSCR $transfer — Input Parameters |
Input parameters for $transfer. Uses logical-only references for subject (NHS no) and organizations (ODS). |
| MODS DSCR $transfer — Output Parameters |
Output parameters for $transfer. Returns OperationOutcome first and echoes logical-only references (identifier + display). |
| MODS Daily Living Observation |
Observation of activities relating to personal care and mobility about the home that are basic to daily living |
| MODS Education History Observation |
Observation capturing the details of a person's educational history. |
| MODS Flag |
This profile defines the MODS constraints and extensions on the HL7 FHIR Flag resource Flag |
| MODS Instruction Task |
Information about how care should be provided, including a set of planned / scheduled activities, as well as a record of the actions that have been completed and the outcomes of those actions |
| MODS Location |
This profile defines the MODS constraints and extensions on the UKCore FHIR Resource Location |
| MODS Need Observation |
Observation capturing a All health and care needs, including emotional, social, cultural, religious and spiritual needs. |
| MODS Occupational History Observation |
Observation capturing the current and/or previous occupation(s) of a person. |
| MODS Organization |
This profile defines the MODS constraints and extensions on the UKCore FHIR Resource Organization |
| MODS Patient |
This profile defines the MODS constraints and extensions on the UKCore FHIR Resource Patient |
| MODS Practitioner |
This profile defines the MODS constraints and extensions on the UKCore FHIR Resource Practitioner |
| MODS Preference Observation |
A description of what is most important to a person, the people who are important to a person and things a person wants someone supporting them to do or not to do. |
| MODS Related Person |
This profile defines the MODS constraints and extensions on the UKCore FHIR Resource RelatedPerson |
| MODS Risk Assessment Observation |
An assessment of health, safety, wellbeing and ability to manage essential daily routines |
| MODS Risk Observation |
Observation capturing a subject of care risk |
| MODS Safeguarding Observation |
Identified safeguarding concerns protecting vulnerable people from neglect or physical, financial, psychological, verbal or other forms of abuse. Implementation guidance: It is recognised that local authorities may not record the details of safeguarding concerns as a matter of policy. In such scenarios, health and social care organisations enquiring about a safeguarding flag may be directed to the local Multi-Agency Safeguarding Hub (MASH) team. |
| MODS Social Circumstance Observation |
Observation capturing the details of a persons social circumstances. |
| MODS Wish Observation |
Observation capturing a subject of care wish/preference |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| Extension MODS Address Country |
The country of the patient's place of residence (ISO3166 Countries) |
| Extension MODS Female Pregnancy Status |
An indication of whether the female PERSON is pregnant. |
| Extension MODS Observation/Planning/Activity Location (reference) |
Used across various MODS entities, typically activities, observations, planning |
| Extension MODS Participant Care Actor |
A care actor who is involved in, kept informed by, performs, proxies or is responsible for a subject of care observation, instruction or task |
| Extension MODS Person Care Provider |
A provider organisation, registered with the Care Quality Commission to provide personal care and support to the Subject of care. |
| Extension MODS Person Death Details |
Information relating to the death of a PERSON, including the date and cause of death |
| Extension MODS Person Email Address Type |
MODS type of email address, home, work |
| Extension MODS Person Gender Identity |
The gender identity of a PERSON as stated by the PERSON. |
| Extension MODS Person Immigration Status |
The immigration status of the individual; for example Asylum Seeker. |
| Extension MODS Person Nationality |
The NATIONALITY of a PERSON, as specified by a PERSON. |
| Extension MODS Person Ordinarily Resident In |
Local authority where the person is ordinarily resident in, as defined in the Care Act 2014 |
| Extension MODS Person Pronoun(s) |
The preferred pronouns for the person. Eg: He/Him, She/Her, They/Them etc. |
| Extension MODS Person Telephone Number Type |
MODS type of telephone number, e.g. Carer, Work, Old |
| Extension MODS Problem reference |
Used across various MODS entities, typically activities, observations, planning |
| Extension MODS Religious Affiliation |
The RELIGIOUS_OR_OTHER_BELIEF_SYSTEM_AFFILIATION of a PERSON, as specified by a PERSON. Note: This is the Religious_Affiliation of a PERSON, not their Religion. |
| Extension MODS Sexual Orientation |
Indication of the person's sexual preferences |
| Extension MODS Transfer Task Participant |
A person who requests or fulfills a transfer |
These define sets of codes used by systems conforming to this implementation guide.
These define new code systems used by systems conforming to this implementation guide.
These define transformations to convert between data structures used by systems conforming to this implementation guide.
These define transformations to convert between codes by systems conforming with this implementation guide.
| MODS Email Use Type to FHIR Contact Point Use |
A mapping between the MODS telecom use type and fhir contact point use |
| MODS Telephone Use Type to FHIR Contact Point Use |
A mapping between the MODS telecom use type and fhir contact point use |
| Maps FHIR resource/operation codes to MODS Structure Map Coding |
Used by the MODS Adapter MODS Service to lookup transforms for FHIR -> MODS |
| Maps MODS Allergy Severity to FHIR Reaction Event Severity and vice-versa |
A mapping to/from the MODS allergy severity and FHIR reaction event severity code systems |
| Maps MODS Data Class Codes to FHIR Structure Map Coding |
Used by the MODS Adapter FHIR Service to lookup transforms for MODS -> FHIR |
| Maps MODS Gender Identity to FHIR Administrative Gender and vice-versa |
A mapping between the MODS gender identity and FHIR administrative gender code systems |
| Maps MODS Sex to FHIR Administrative Gender and vice-versa |
A mapping to/from the MODS sex and FHIR gender code systems |
| Maps MODS Status Codes to FHIR Status Codes (for various observations) |
A mapping to/from the MODS Flag Status to FHIR Flag Status |
| Maps MODS type of reaction to FHIR allergy intolerance type and vice-versa |
A mapping to/from the MODS type of reaction to FHIR allergy intolerance type code systems |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| MODS Allergy AllergyIntolerance |
This example was generated by executing the $transform operation using the Allergy to AllergyIntolerance StructureMap and a MODS Allergy resource. |
| MODS FHIR About Me Observation |
Populated with subject, performer and all PRSB About Me sections. This example was generated by executing the $transform operation using the About Me to About Me Observation StructureMap and a MODS About Me resource. |
| MODS FHIR Daily Living Observation |
This example was generated by executing the $transform operation using Daily Living to Daily Living Observation Structure Map and a MODS Daily Living resource. |
| MODS FHIR Education History Observation |
This example was generated by executing the $transform operation using Education History to Education History Observation Structure Map and a MODS Education History resource. |
| MODS FHIR Need Observation |
This example was generated by executing the $transform operation using Need to Need Observation Structure Map and a MODS Needs resource. |
| MODS FHIR Occupational History Observation |
This example was generated by executing the $transform operation using Occupational History to Occupational History Observation Structure Map and a MODS Occupational History resource. |
| MODS FHIR Organization |
Populated with name, organisation identifier (ODS) and address details. This example was generated by executing the $transform operation using the Care Organisation to Organization StructureMap and a MODS Care Organisation resource. |
| MODS FHIR Patient |
Fully Populated, including death details. This example was generated by executing the $transform operation using the Subject of Care to Patient StructureMap and a MODS Subject of Care. |
| MODS FHIR Patient Registration |
"Skinny" patient resource created as a result of a Subject of Care Registration. This example was generated by executing the $transform operation using the Subject of Care Registration to Patient StructureMap and a MODS Subject of Care Registration. |
| MODS FHIR Patient Registration (Permanent Failure) |
Contains operation outcome and registration error http://build.fhir.org/ig/FHIR/fhir-tools-ig/branches/master/CodeSystem-ig-parameters.html This example was generated by executing the $transform operation using the Subject of Care Registration to Patient StructureMap and a MODS Subject of Care Registration. |
| MODS FHIR Practitioner |
Populated with name and contact details. This example was generated by executing the $transform operation using the Care Worker to Practitioner StructureMap and a MODS Care Worker resource. |
| MODS FHIR Related Person |
This example was generated by executing the $transform operation using the Proxy for Subject of Care to Related Person StructureMap and a MODS Proxy for Subject of Care resource. |
| MODS FHIR Risk Observation |
Fairly complete example (missing informed and end date). This example was generated by executing the $transform operation using Risk to Risk Observation Structure Map and a MODS Risk resource. |
| MODS FHIR Safeguarding Observation |
This example was generated by executing the $transform operation using Safeguarding to Safeguarding Observation Structure Map and a MODS Safeguarding resource. |
| MODS FHIR Social Circumstance Observation |
This example was generated by executing the $transform operation using Social Circumstance to Social Circumstance Observation Structure Map and a MODS Social Circumstance resource. |
| MODS FHIR Task |
Fully populated. This example is the expected input necessary to transform to a MODS Transfer using the Task to Transfer StructureMap. |
| MODS FHIR Trace Patient (NHS FHIR PDS API Traced/Platform Response) |
Example generated from the TEST PDS FHIR API This patient resource example will be transformed to a MODS Trace response using the Patient Trace StructureMap and a FHIR UK Core Patient Resource. |
| MODS FHIR Transfer Task |
Work in progress. |
| MODS FHIR Wish Observation |
This example was generated by executing the $transform operation using Wish to Wish Observation Structure Map and a MODS Wish resource. |
| MODS Subject of Care/Patient Flag |
This example was generated by executing the $transform operation using the Alert to Flag StructureMap and a MODS Flag resource. |
These are resources that are used within this implementation guide that do not fit into one of the other categories.
| Parameters/FHIR-Transfer-In-Parameters |
| Parameters/FHIR-Transfer-Out-Parameters |