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 TPP

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

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 IM1TransactionTPPFacade

Facade - IM1 Transaction TPP

  • 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		yyfamily, given, telecom, birthdate, address-postalcode, gender
QuestionnaireResponsehttps://fhir.virtually.healthcare/StructureDefinition/QuestionnaireResponse
Additional supported profiles:
  https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse		y

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 by surname

GET /Patient?family=Avocet
Search Parameters
ConformanceParameterTypeDocumentation
SHALLfamilystring

A patients surname

SHALLgivenstring

A patients first name

SHALLtelecomtoken

A patients phone number or email address

SHALLbirthdatedate

A patients date of birth

SHALLaddress-postalcodestring

A patients postcode

SHALLgendertoken

A patients gender - administrative

 

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 TPP