Interactions

Query for an FGM indicator

HTTP request and headers

GET /Flag?
   patient:identifier=https://fhir.nhs.uk/Id/nhs-number|<nhs-number>
   Authorization = Bearer <access token>
   TraceID = <yourRef>

Parameters

The patient's NHS Number. This must be a verified NHS Number.

• patient:identifier (required), type token.

HTTP response and headers

Content-Type = <application/fhir+json>
Date = <servedDateTime>

HTTP response body

Create an FGM indicator

HTTP request and headers

POST /Flag
   Authorization = Bearer <access token>
   TraceID = <yourRef>

Request body

A FHIR Flag conforming to the UKCore-Flag profile. Values set as per Data mapping

• Example - An active FGM flag

HTTP response and headers

Content-Type = <application/fhir+json>
Date = <servedDateTime>

HTTP response body

Remove an FGM indicator

HTTP request and headers

PUT /Flag/<id>
   Authorization = Bearer <access token>
   TraceID = <yourRef>

Parameters

The id of the Flag resource being updated (marked as removed).

• id (required)

Request body

A FHIR Flag conforming to the UKCore-Flag profile. Values set as per Data mapping

• the id element value must be identical to the [id] in the URL
• the status must be set to either 'inactive' or 'entered-in-error'.
• Extension-England-FlagRemovalReason must be included.
• The Flag resource being updated (signified by [id]) must have a current server status of 'active'. No changes will be persisted to a Flag which has already been removed.
• The PUT interaction only supports updates to status and delete reason. Other fields should be supplied but will not be updated.
• Example - A removed FGM flag

HTTP response and headers

Content-Type = <application/fhir+json>
Date = <servedDateTime>

HTTP response body