Virtually Healthcare HL7 FHIR R4 Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR R4 Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR R4 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/HL7-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir.virtually.healthcare/CapabilityStatement/NHSEFacade | Version: 0.1.0-current | |||
| Draft as of 2024-10-08 | Computable Name: NHSEnglandFacade | |||
This is a Service Facade to Personal Demographics Service - FHIR API and Organisation Data Service - FHIR API
This facade is related to IHE Patient Demographics Query for Mobile (PDQm) and IHE Mobile Care Services Discovery (mCSD)
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement NHSEFacade
application/fhir+xml, application/fhir+jsonNote 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.
serverThe summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Patient | https://fhir.virtually.healthcare/StructureDefinition/Patient Additional supported profiles: UK Core Patient | y | y | identifier, name, family, given, birthdate, gender, death-date, address-postalcode, general-practitioner, email, phone | |||||
| QuestionnaireResponse | https://fhir.virtually.healthcare/StructureDefinition/QuestionnaireResponse Additional supported profiles: UK Core Questionnaire Response | y | questionnaire, patient, patient:identifier | ||||||
| RelatedPerson | https://fhir.virtually.healthcare/StructureDefinition/RelatedPerson Additional supported profiles: UK Core Related Person | y | patient:identifier | ||||||
| Organization | https://fhir.virtually.healthcare/StructureDefinition/Organization Additional supported profiles: UK Core Organization | y | y | identifier, name, active, address-postalcode, address-city, ods-org-primaryRole, type |
read, search-type.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
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | A patients NHS Number e.g. |
| SHALL | name | string | A patients name |
| SHALL | family | string | A patients surname |
| SHALL | given | string | A patients first name |
| SHALL | birthdate | date | A patients date of birth |
| SHALL | gender | token | A patients gender - administrative |
| SHALL | death-date | token | A patients date of birth |
| SHALL | address-postalcode | string | A patients postcode |
| SHALL | general-practitioner | token | A patients general practice |
| SHALL | token | A patients email address | |
| SHALL | phone | token | A patients phone number |
search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | questionnaire | reference | The questionnaire the answers are provided for, e.g. |
| SHALL | patient | reference | The patient that is the subject of the questionnaire response, e.g. |
| SHALL | patient:identifier | token | The patient identifier that is the subject of the questionnaire response, e.g. |
search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient:identifier | token | The patient identifier this related person is related to, e.g. |
read, search-type.GET /Organization?{parameters}Conformance to this implementation guide SHOULD be tested via FHIR Validation.
Search Examples
Search for Organization's for a patient with a ODS Code of RR8
GET /Organization?identifier=https://fhir.nhs.uk/Id/ods-organization-code|RR8
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | A organisations ODS Code e.g. |
| SHALL | name | string | A portion of the organization's name or alias |
| SHALL | active | token | Is the Organization record active |
| SHALL | address-postalcode | string | A postal code specified in an address |
| SHALL | address-city | string | A city specified in an address |
| SHALL | ods-org-primaryRole | token | organisation ods primary role |
| SHALL | type | token | A code for the type of organization |