NHnhs

Get relationship details

Changed on

Overview

Use this endpoint to a retrieve a single relationship record based on its unique identifier. This record describes a relationship between a pair of organisations. The types of relationships which an organisation may have will vary depending on the primary role of the organisation. In some case there may be multiple relationships between the same two organisations, each having a different relationship type.

A FHIR OrganizationAffiliation Resource will be returned when a valid id is provided. Refer to our Implementation Guidance pages for profiles and other FHIR assets.

get/OrganizationAffiliation/{id}

Request

  • Base URL
    https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir
  • URL
    https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/OrganizationAffiliation/{id}
  • Auth
    none declared

Path parameters

idstring required
Example:617400

The relationship ID.

Response

Valid request that returns a FHIR OrganizationAffiliation resource

Changes