HL7 UK - UK Core Access
0.1.0 - ci-build United Kingdom flag

HL7 UK - UK Core Access, published by HL7 UK. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-UK/UK-Core-Access/ and changes regularly. See the Directory of published versions

Consumer

Locating a FHIR Server

It is assumed that Consumers will discover the URLs of FHIR RESTful endpoints from sources including:

  • local configuration
  • local, regional or national directory services

capabilities

A Consumer MAY use the capabilities interaction to retrieve a CapabilityStatement from a Provider specifying which resource types and interactions are supported by the FHIR endpoint. For example:

GET [base]/metadata

A Consumer MAY use the CapabilityStatement during implementation to discover the capabilities of a FHIR endpoint provided by a UK Core Access Provider.

A Consumer MAY retrieve the CapabilityStatement at runtime to discover the current capabilities of a FHIR endpoint and to adapt to changes in capability. For example:

  • a Provider may be experiencing failures within their system so that some capabilities are temporarily unavailable
  • a Provider may start to provide new capabilities

A Consumer MAY use the Patient search capability from a Patient Index Provider to retrieve a set of Patient resources matching the search criteria. This interaction can be used where the consumer knows some demographic details about the individual and needs to find further information related to the individual such as additional demographic details and business identifiers (e.g. NHS Number). For example:

GET [base]/Patient?birthdate=[date]&family=[name]

Similarly, a Consumer MAY use the Patient search capability from a Clinical Data Provider to retrieve a set of Patient resources matching the search criteria. This interaction can be used where the consumer knows business identifiers for the individual (e.g. NHS Number) and needs to find the logical identifier (i.e. id) for the individual on this FHIR server. For example:

GET [base]/Patient?identifier=[Identifier]

A Consumer MAY use the AllergyIntolerance search capability from a Clinical Data Provider to retrieve a set of AllergyIntolerance resources matching the search criteria. This interaction can be used where the consumer knows the logical identifier for the individual (i.e. id) on this FHIR server and needs to find allergies and intolerances related to this individual. For example:

GET [base]/AllergyIntolerance?patient=[id]

A Consumer MAY use the Immunization search capability from a Clinical Data Provider to retrieve a set of Immunization resources matching the search criteria. This interaction can be used where the consumer knows the logical identifier for the individual (i.e. id) on this FHIR server and needs to find immunizations related to this individual. For example:

GET [base]/Immunization?patient=[id]

A Consumer MAY use the MedicationStatement search capability from a Clinical Data Provider to retrieve a set of MedicationStatement resources matching the search criteria. This interaction can be used where the consumer knows the logical identifier for the individual (i.e. id) on this FHIR server and needs to find medications used by this individual. For example:

GET [base]/MedicationStatement?patient=[id]