FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/IM1PatientEMISFacade

Packagefhir.virtually.healthcare
TypeCapabilityStatement
IdIM1PatientEMISFacade
FHIR VersionR4
Sourcehttps://fhir.virtually.healthcare/https://build.fhir.org/ig/Virtually-Healthcare/R4/CapabilityStatement-IM1PatientEMISFacade.html
URLhttps://fhir.virtually.healthcare/CapabilityStatement/IM1PatientEMISFacade
Version0.1.1-current
Statusdraft
Date2024-10-08
NameIM1PatientEMISFacade
TitleFacade - IM1 Patient EMIS
Realmus
Authorityhl7
DescriptionThis is a [Service Facade](ActorDefinition-ServiceFacade.html) to [IM1 Patient](https://digital.nhs.uk/services/gp-it-futures-systems/im1-pairing-integration/interface-mechanisms-guidance#patient) This is influenced by [HL7 International Patient Access](https://build.fhir.org/ig/HL7/fhir-ipa/) This is not a complete description of the API and so does not represent the actual implemented API or capabilities of the GP provider. This is a facade to the GP System IM1, this is not the API provided by the GP System.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
AllergyIntoleranceAllergyIntolerance
BinaryBinary
DocumentReferenceDocumentReference
EncounterEncounter
ImmunizationImmunization
MedicationRequestMedicationRequest
ObservationObservation
PatientPatient
QuestionnaireResponseQuestionnaireResponse
TaskTask
UKCore-PatientUK Core Patient

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement IM1PatientEMISFacade

Facade - IM1 Patient EMIS

  • Implementation Guide Version: 0.1.1-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2024-10-08
  • Published by: Virtually Healthcare

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCDSearches_include_revincludeOperations
Patienthttps://fhir.virtually.healthcare/StructureDefinition/Patient
Additional supported profiles:
  UK Core Patient
yy
AllergyIntolerancehttps://fhir.virtually.healthcare/StructureDefinition/AllergyIntolerance
Additional supported profiles:
  UK Core Allergy Intolerance
ypatient, date
Conditionhttp://hl7.org/fhir/StructureDefinition/Condition
Additional supported profiles:
  UK Core Condition
ypatient, onset-date
DocumentReferencehttps://fhir.virtually.healthcare/StructureDefinition/DocumentReference
Additional supported profiles:
  UK Core Document Reference
ypatient, date
Immunizationhttps://fhir.virtually.healthcare/StructureDefinition/Immunization
Additional supported profiles:
  UK Core Immunization
ypatient, date
MedicationRequesthttps://fhir.virtually.healthcare/StructureDefinition/MedicationRequest
Additional supported profiles:
  UK Core Medication Request
ypatient, authoredon
Observationhttps://fhir.virtually.healthcare/StructureDefinition/Observation
Additional supported profiles:
  UK Core Observation
ypatient, date, category
Binaryhttps://fhir.virtually.healthcare/StructureDefinition/Binaryy
Encounterhttps://fhir.virtually.healthcare/StructureDefinition/Encounter
Additional supported profiles:
  UK Core Encounter
ypatient, date
Communicationhttp://hl7.org/fhir/StructureDefinition/Communication
Additional supported profiles:
  UK Core Communication
yyypatient
Taskhttps://fhir.virtually.healthcare/StructureDefinition/Task
Additional supported profiles:
  UK Core Task
yyypatient, authored-on
QuestionnaireResponsehttps://fhir.virtually.healthcare/StructureDefinition/QuestionnaireResponse
Additional supported profiles:
  UK Core Questionnaire Response
yypatient, questionnaire

Resource Conformance: SHALL Patient

Base System Profile
Patient
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Patient

Interaction summary
  • Supports read, update.

Documentation

TODO

Resource Conformance: SHALL AllergyIntolerance

Base System Profile
AllergyIntolerance
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Allergy Intolerance

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Who the sensitivity is for

SHALLdatedate

Date first version of the resource instance was recorded

 

Resource Conformance: SHALL Condition

Base System Profile
Condition
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Condition

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Who has the condition?

SHALLonset-datedate

Date related onsets (dateTime and Period)

 

Resource Conformance: SHALL DocumentReference

Base System Profile
DocumentReference
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Document Reference

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Who/what is the subject of the document

SHALLdatedate

When this document reference was created

 

Resource Conformance: SHALL Immunization

Base System Profile
Immunization
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Immunization

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The patient for the vaccination record

SHALLdatedate

Vaccination (non)-Administration Date

 

Resource Conformance: SHALL MedicationRequest

Base System Profile
MedicationRequest
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Medication Request

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Returns prescriptions for a specific patient

SHALLauthoredondate

Return prescriptions written on this date

 

Resource Conformance: SHALL Observation

Base System Profile
Observation
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Observation

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The subject that the observation is about (if patient)

SHALLdatedate

Obtained date/time. If the obtained element is a period, a date that falls in the period

SHALLcategorytoken

The classification of the type of observation

 

Resource Conformance: SHALL Binary

Base System Profile
Binary
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Resource Conformance: SHALL Encounter

Base System Profile
Encounter
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Encounter

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The patient or group present at the encounter

SHALLdatedate

A date within the period the Encounter lasted

 

Resource Conformance: SHALL Communication

Base System Profile
Communication
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Communication

Interaction summary
  • Supports search-type, create, delete.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Focus of message

 

Resource Conformance: SHALL Task

Base System Profile
Task
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Task

Interaction summary
  • Supports search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Search by patient

SHALLauthored-ondate

Search by creation date

 

Resource Conformance: SHALL QuestionnaireResponse

Base System Profile
QuestionnaireResponse
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, create.

Documentation

Pharmacy Nomination Only (questionnaire = https://fhir.virtually.healthcare/PharmacyNomination)

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The patient that is the subject of the questionnaire response

SHALLquestionnairereference

The questionnaire the answers are provided for

 

Source

{
  "resourceType": "CapabilityStatement",
  "id": "IM1PatientEMISFacade",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://fhir.virtually.healthcare/CapabilityStatement/IM1PatientEMISFacade",
  "version": "0.1.1-current",
  "name": "IM1PatientEMISFacade",
  "title": "Facade - IM1 Patient EMIS",
  "status": "draft",
  "experimental": false,
  "date": "2024-10-08",
  "publisher": "Virtually Healthcare",
  "contact": [
    {
      "name": "Virtually Healthcare",
      "telecom": [
        {
          "system": "url",
          "value": "https://virtually.healthcare"
        }
      ]
    }
  ],
  "description": "This is a [Service Facade](ActorDefinition-ServiceFacade.html) to [IM1 Patient](https://digital.nhs.uk/services/gp-it-futures-systems/im1-pairing-integration/interface-mechanisms-guidance#patient)\n\nThis is influenced by [HL7 International Patient Access](https://build.fhir.org/ig/HL7/fhir-ipa/)\n\nThis is not a complete description of the API and so does not represent the actual implemented API or capabilities of the GP provider. This is a facade to the GP System IM1, this is not the API provided by the GP System.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "GB",
          "display": "United Kingdom of Great Britain and Northern Ireland"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "rest": [
    {
      "mode": "server",
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Patient",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/Patient",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient"
          ],
          "documentation": "TODO",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "update"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "AllergyIntolerance",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/AllergyIntolerance",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance"
          ],
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference",
              "documentation": "Who the sensitivity is for"
            },
            {
              "name": "date",
              "type": "date",
              "documentation": "Date first version of the resource instance was recorded"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Condition",
          "profile": "http://hl7.org/fhir/StructureDefinition/Condition",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition"
          ],
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference",
              "documentation": "Who has the condition?"
            },
            {
              "name": "onset-date",
              "type": "date",
              "documentation": "Date related onsets (dateTime and Period)"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "DocumentReference",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/DocumentReference",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference"
          ],
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference",
              "documentation": "Who/what is the subject of the document"
            },
            {
              "name": "date",
              "type": "date",
              "documentation": "When this document reference was created"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Immunization",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/Immunization",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization"
          ],
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference",
              "documentation": "The patient for the vaccination record"
            },
            {
              "name": "date",
              "type": "date",
              "documentation": "Vaccination (non)-Administration Date"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "MedicationRequest",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/MedicationRequest",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest"
          ],
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference",
              "documentation": "Returns prescriptions for a specific patient"
            },
            {
              "name": "authoredon",
              "type": "date",
              "documentation": "Return prescriptions written on this date"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Observation",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/Observation",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation"
          ],
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference",
              "documentation": "The subject that the observation is about (if patient)"
            },
            {
              "name": "date",
              "type": "date",
              "documentation": "Obtained date/time. If the obtained element is a period, a date that falls in the period"
            },
            {
              "name": "category",
              "type": "token",
              "documentation": "The classification of the type of observation"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Binary",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/Binary",
          "interaction": [
            {
              "code": "read"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Encounter",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/Encounter",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter"
          ],
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference",
              "documentation": "The patient or group present at the encounter"
            },
            {
              "name": "date",
              "type": "date",
              "documentation": "A date within the period the Encounter lasted"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Communication",
          "profile": "http://hl7.org/fhir/StructureDefinition/Communication",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Communication"
          ],
          "interaction": [
            {
              "code": "search-type"
            },
            {
              "code": "create"
            },
            {
              "code": "delete"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference",
              "documentation": "Focus of message"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Task",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/Task",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Task"
          ],
          "interaction": [
            {
              "code": "search-type"
            },
            {
              "code": "create"
            },
            {
              "code": "update"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference",
              "documentation": "Search by patient"
            },
            {
              "name": "authored-on",
              "type": "date",
              "documentation": "Search by creation date"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "QuestionnaireResponse",
          "profile": "https://fhir.virtually.healthcare/StructureDefinition/QuestionnaireResponse",
          "supportedProfile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse"
          ],
          "documentation": "Pharmacy Nomination Only (questionnaire = https://fhir.virtually.healthcare/PharmacyNomination)",
          "interaction": [
            {
              "code": "search-type"
            },
            {
              "code": "create"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference",
              "documentation": "The patient that is the subject of the questionnaire response"
            },
            {
              "name": "questionnaire",
              "type": "reference",
              "documentation": "The questionnaire the answers are provided for"
            }
          ]
        }
      ]
    }
  ]
}