Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

FHIR

The following pages and posts are tagged with

Title Type Excerpt
Foundation | CapabilityStatement Page A Capability Statement is a set of capabilities of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or...
Foundation | CodeSystem Page A CodeSystem defines a set of codes with meanings.
Foundation | ValueSet Page A ValueSet selects a set of codes from those defined by one or more code systems.
Interaction Page Interaction describes ReSTful interactions and operations required to exchange Reasonable Adjustment information via Spine using the FHIR® Reasonable Adj...
Patient Demographics Page Details of the ways to obtain and verify an NHS number before calling the reasonable adjustments API
Headers Page An overview of the security requirements for FHIR API calls into Spine.
Interaction | Create Page Create operation describes interaction required to record a new Reasonable Adjustment Flag, an Adjustment or an Impairment on Spine via the FHIR® Reasona...
Interaction | Delete Page Delete describes the interaction required to close or (soft) delete an Adjustment or an Impairment on Spine via the FHIR® Reasonable Adjustments API. [To...
Interaction | Read Page Read operation describes interaction required to retrieve and view Reasonable Adjustment Flag, Adjustment or Impairment details from Spine via the FHIR® ...
Interaction | Update Page Update interaction describes the interaction required to update List resources via the FHIR® Reasonable Adjustments API. These are used to manage the Imp...
JWT Payload and Scope Page An overview of the specific security requirements for FHIR API calls into the FHIR® Reasonable Adjustments API via Spine.
Operation | Determine Provenance Page Provenance operation describes the server-side operations required to populate, cache and return Provenance information (Practitioner and Organisation inform...
Operation | Remove Flag Page Remove Flag operation describes the operation required to remove (soft delete) a Reasonable Adjustment Flag entirely, including all Adjustments, Impairments ...
API Security Page An overview of the security requirements for FHIR API calls into Spine.
Interaction | Read Page Describes additional examples of resource instances to illustrate acceptable implementation of the Resource Profile StructureDefinitions.
Interaction | Read Page Describes additional examples of resource instances to illustrate acceptable implementation of the Resource Profile StructureDefinitions.
Interaction | Create Page Create operation describes interaction required to record a new Reasonable Adjustment Flag, an Adjustment or an Impairment on Spine via the FHIR® Reasona...
Interaction | Create Page Create operation describes interaction required to record a new Reasonable Adjustment Flag, an Adjustment or an Impairment on Spine via the FHIR® Reasona...
Interaction | Read Page Read operation describes interaction required to request and retrieve (and display) a Reasonable Adjustment Flag on Spine via the FHIR® Reasonable Adjust...
Interaction | Read Page Read operation describes interaction required to request and retrieve (and display) a Reasonable Adjustment Flag on Spine via the FHIR® Reasonable Adjust...
Interaction | Use Case Examples Remix Page Updated Use Cases and examples illustrating requirements for operation of the FHIR® Reasonable Adjustments API
Interaction | Update Page Update operation describes interaction required to update a Reasonable Adjustment Flag, an Adjustment or an Impairment on Spine via the FHIR® Reasonable ...
Interaction | Update Page Update operation describes interaction required to update a Reasonable Adjustment Flag, an Adjustment or an Impairment on Spine via the FHIR® Reasonable ...
RARecord Resources Overview Page Overview of the Resources section: resources used within the FHIR® Reasonable Adjustments API.
Capability Statement Page How capabilities of FHIR® Reasonable Adjustments API server implementations are recorded and served.
RARecord CodeSystems Page This page describes CodeSystems used within the FHIR® Reasonable Adjustments API.
RARecord Extensions Page This page describes Extensions required for the Profile StructureDefinitions within the FHIR® Reasonable Adjustments API.
RARecord Profiles Page This page describes Resource and Profile StructureDefinitions required to support data transmission within the FHIR® Reasonable Adjustments API.
RARecord ValueSets Page This page describes Valuesets required by the Profiles in the FHIR® Reasonable Adjustments API.
Versioning of Resources Page How resources are versioned to allow local caching, and to avoid contention when updating resources
RARecord Profiles Page This page describes Resource and Profile StructureDefinitions required to support data transmission within the FHIR® Reasonable Adjustments API.
API Codes Page Details of the API Codes used in the responses.
ODS Lookup | Reference Page Developer Cheat Sheet shortcuts for the technical build of FHIR® ODS Lookup API.
Identification | Organization Page A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companie...

All content is available under the Open Government Licence v3.0, except where otherwise stated