Virtually Healthcare HL7 FHIR Implementation Guide
0.1.0-current - ci-build United Kingdom flag

Virtually Healthcare HL7 FHIR Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/Virtually-Healthcare-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions

CapabilityStatement: Facade - IM1 Transaction EMIS

Official URL: https://fhir.virtually.healthcare/CapabilityStatement/IM1TransactionEMISFacade Version: 0.1.0-current
Draft as of 2024-10-08 Computable Name: IM1TransactionEMISFacade

This is a Service Facade to IM1 Transaction

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.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement IM1TransactionEMISFacade

Facade - IM1 Transaction EMIS

  • Implementation Guide Version: 0.1.0-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 TypeProfileRSUCSearches_include_revincludeOperations
Patienthttps://fhir.virtually.healthcare/StructureDefinition/Patient
Additional supported profiles:
  UK Core Patient
yyidentifier, name, birthdate
AllergyIntolerancehttps://fhir.virtually.healthcare/StructureDefinition/AllergyIntolerance
Additional supported profiles:
  UK Core AllergyIntolerance
ypatient
Conditionhttps://fhir.virtually.healthcare/StructureDefinition/Condition
Additional supported profiles:
  UK Core Condition
ypatient
DocumentReferencehttps://fhir.virtually.healthcare/StructureDefinition/DocumentReference
Additional supported profiles:
  https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference
ypatient
Immunizationhttps://fhir.virtually.healthcare/StructureDefinition/Immunization
Additional supported profiles:
  UK Core Immunization
ypatient
MedicationRequesthttps://fhir.virtually.healthcare/StructureDefinition/MedicationRequest
Additional supported profiles:
  UK Core MedicationRequest
ypatient, authoredon
Observationhttps://fhir.virtually.healthcare/StructureDefinition/Observation
Additional supported profiles:
  UK Core Observation
ypatient
Taskhttps://fhir.virtually.healthcare/StructureDefinition/Task
Additional supported profiles:
  https://fhir.hl7.org.uk/StructureDefinition/UKCore-Task
ypatient
Compositionhttps://fhir.virtually.healthcare/StructureDefinition/Composition
Additional supported profiles:
  UK Core Composition
ypatient, date
QuestionnaireResponsehttps://fhir.virtually.healthcare/StructureDefinition/QuestionnaireResponse
Additional supported profiles:
  https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse
y
Appointmenthttp://hl7.org/fhir/StructureDefinition/Appointment
Additional supported profiles:
  UK Core Appointment
y
Slothttp://hl7.org/fhir/StructureDefinition/Slot
Additional supported profiles:
  UK Core Slot
yschedule
Schedulehttp://hl7.org/fhir/StructureDefinition/Schedule
Additional supported profiles:
  UK Core Schedule
yservice-type, date

Resource Conformance: SHALL Patient

Base System Profile
Patient
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Patient

Interaction summary
  • Supports read, search-type.

Documentation
GET /Patient?{parameters}

Conformance to this implementation guide SHOULD be tested via FHIR Validation.

Search Examples

Search for Patient's for a patient with a NHS Number of 9876543210

GET /Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210
Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

A patients NHS Number e.g. identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210

SHALLnamestring

A server defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, and/or text

SHALLbirthdatedate

A patients date of birth

 

Resource Conformance: SHALL AllergyIntolerance

Base System Profile
AllergyIntolerance
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core AllergyIntolerance

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Who the sensitivity is for

 

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?

 

Resource Conformance: SHALL DocumentReference

Base System Profile
DocumentReference
Profile Conformance
SHALL
Reference Policy

Supported Profiles

https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Who/what is the subject of the document

 

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

 

Resource Conformance: SHALL MedicationRequest

Base System Profile
MedicationRequest
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core MedicationRequest

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)

 

Resource Conformance: SHALL Task

Base System Profile
Task
Profile Conformance
SHALL
Reference Policy

Supported Profiles

https://fhir.hl7.org.uk/StructureDefinition/UKCore-Task

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Search by patient

 

Resource Conformance: SHALL Composition

Base System Profile
Composition
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Composition

Interaction summary
  • Supports search-type.

Documentation

Consultations

Not fully implemented, used for testing writebacks.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Who and/or what the composition is about

SHALLdatedate

Composition editing time

 

Resource Conformance: SHALL QuestionnaireResponse

Base System Profile
QuestionnaireResponse
Profile Conformance
SHALL
Reference Policy

Supported Profiles

https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse

Interaction summary
  • Supports create.

Documentation

Writeback clinically coded (UK SNOMED CT) consultations to EMIS

Resource Conformance: SHALL Appointment

Base System Profile
Appointment
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Appointment

Interaction summary
  • Supports create.

Resource Conformance: SHALL Slot

Base System Profile
Slot
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Slot

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLschedulereference

The Schedule Resource that we are seeking a slot within

 

Resource Conformance: SHALL Schedule

Base System Profile
Schedule
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Schedule

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLservice-typetoken

The type of appointments that can be booked into associated slot(s)

SHALLdatedate

Search for Schedule resources that have a period that contains this date specified