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 - Personal Demographics Service - FHIR API

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

This is a Service Facade to Personal Demographics Service - FHIR API

This facade is related to IHE Patient Demographics Query for Mobile (PDQm)

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement PDSFacade

Facade - Personal Demographics Service - FHIR API

  • 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, family, given, birthdate, gender, death-date, address-postalcode, general-practitioner, email, phone

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 patients name

SHALLfamilystring

A patients surname

SHALLgivenstring

A patients first name

SHALLbirthdatedate

A patients date of birth

SHALLgendertoken

A patients gender - administrative

SHALLdeath-datetoken

A patients date of birth

SHALLaddress-postalcodestring

A patients postcode

SHALLgeneral-practitionertoken

A patients general practice

SHALLemailtoken

A patients email address

SHALLphonetoken

A patients phone number