Interactions

Query for an indicator

GET /Flag?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|<nhs-number>

Parameters

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

  • patient:identifier (required), type token.


fgm-is interactions-Get

Outcome Response
Record found SearchSet Bundle -
Command 'pagelink' could not render: Page not found.
No record found SearchSet Bundle -
Command 'pagelink' could not render: Page not found.
Error or validation failure OperationOutcome -
Command 'pagelink' could not render: Page not found.

Create an FGM indicator

POST /Flag

Request body

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

  • Command 'pagelink' could not render: Page not found.


fgm-is interactions-Post

Outcome Response
Flag added Flag -
Command 'pagelink' could not render: Page not found.
Error or validation failure OperationOutcome -
Command 'pagelink' could not render: Page not found.

Remove an FGM indicator

PUT /Flag/<id>

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'.
  • Command 'pagelink' could not render: Page not found.
    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.
  • Command 'pagelink' could not render: Page not found.

Outcome Response
Flag removed Flag -
Command 'pagelink' could not render: Page not found.
Error or validation failure OperationOutcome -
Command 'pagelink' could not render: Page not found.