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 - Organisation Data Service - FHIR API

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

This is a Service Facade to Organisation Data Service - FHIR API

This facade is related to IHE Mobile Care Services Discovery (mCSD)

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement ODSFacade

Facade - Organisation Data 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
Organizationhttps://fhir.virtually.healthcare/StructureDefinition/Organization
Additional supported profiles:
  UK Core Organization		yyidentifier, name, active, address-postalcode, address-city, ods-org-primaryRole, type

Resource Conformance: SHALL Organization

Base System Profile
Organization
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Organization

Interaction summary
  • Supports read, search-type.

Documentation
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
Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

A organisations ODS Code e.g. identifier=https://fhir.nhs.uk/Id/ods-organization-code|RR8

SHALLnamestring

A portion of the organization's name or alias

SHALLactivetoken

Is the Organization record active

SHALLaddress-postalcodestring

A postal code specified in an address

SHALLaddress-citystring

A city specified in an address

SHALLods-org-primaryRoletoken

organisation ods primary role

SHALLtypetoken

A code for the type of organization