WARNING
This guidance is under active development by NHS England and content may be added or updated on a regular basis.Examples
Examples Usage
Whilst every effort has been made to ensure that the examples are correct and useful, they are not a normative part of the specification.Example - An active FGM flag
Important: This page is under development by NHS England
<Flag xmlns="http://hl7.org/fhir"> <id value="FGM-ActiveFlag-Example" /> <status value="active" /> <code> <coding> <system value="http://snomed.info/sct" /> <code value="902961000000107" /> <display value="Family history of FGM (female genital mutilation)" /> </coding> <text value="Family history of FGM (female genital mutilation)" /> </code> <subject> <identifier> <system value="https://fhir.nhs.uk/Id/nhs-number" /> <value value="9000000009" /> </identifier> </subject> <period> <start value="2019-12-10" /> </period> </Flag>
{ "resourceType": "Flag", "id": "FGM-ActiveFlag-Example", "status": "active", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "902961000000107", "display": "Family history of FGM (female genital mutilation)" } ], "text": "Family history of FGM (female genital mutilation)" }, "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9000000009" } }, "period": { "start": "2019-12-10" } }
Example - Invalid NHS number
Important: This page is under development by NHS England
<OperationOutcome xmlns="http://hl7.org/fhir"> <id value="FGM-InvalidNHSNumber-Example" /> <issue> <severity value="error" /> <code value="value" /> <details> <coding> <system value="https://fhir.nhs.uk/CodeSystem/England-SpineErrorOrWarningCode" /> <code value="INVALID_VALUE" /> <display value="Invalid value" /> </coding> </details> <diagnostics value="Invalid NHS Number" /> </issue> </OperationOutcome>
{ "resourceType": "OperationOutcome", "id": "FGM-InvalidNHSNumber-Example", "issue": [ { "severity": "error", "code": "value", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/England-SpineErrorOrWarningCode", "code": "INVALID_VALUE", "display": "Invalid value" } ] }, "diagnostics": "Invalid NHS Number" } ] }
Example - FGM flag found
Important: This page is under development by NHS England
<Bundle xmlns="http://hl7.org/fhir"> <id value="FGM-BundleWithFoundFlag-Example" /> <type value="searchset" /> <total value="1" /> <link> <relation value="self" /> <url value="https:baseurl/Flag?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9000000009" /> </link> <entry> <fullUrl value="https://baseurl/Flag/218755" /> <resource> <Flag> <id value="a6a6a92a-8247-4250-b1c7-10cda16f0310" /> <status value="active" /> <code> <coding> <system value="http://snomed.info/sct" /> <code value="902961000000107" /> <display value="Family history of FGM (female genital mutilation)" /> </coding> <text value="Family history of FGM (female genital mutilation)" /> </code> <subject> <identifier> <system value="https://fhir.nhs.uk/Id/nhs-number" /> <value value="9000000009" /> </identifier> </subject> <period> <start value="2019-12-10" /> </period> </Flag> </resource> <search> <mode value="match" /> </search> </entry> </Bundle>
{ "resourceType": "Bundle", "id": "FGM-BundleWithFoundFlag-Example", "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https:baseurl/Flag?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9000000009" } ], "entry": [ { "fullUrl": "https://baseurl/Flag/218755", "resource": { "resourceType": "Flag", "id": "a6a6a92a-8247-4250-b1c7-10cda16f0310", "status": "active", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "902961000000107", "display": "Family history of FGM (female genital mutilation)" } ], "text": "Family history of FGM (female genital mutilation)" }, "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9000000009" } }, "period": { "start": "2019-12-10" } }, "search": { "mode": "match" } } ] }
Example - FGM flag not found
Important: This page is under development by NHS England
<Bundle xmlns="http://hl7.org/fhir"> <id value="FGM-BundleWithNoFlag-Example" /> <type value="searchset" /> <total value="0" /> <link> <relation value="self" /> <url value="https:baseurl/Flag?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9000000009" /> </link> </Bundle>
{ "resourceType": "Bundle", "id": "FGM-BundleWithNoFlag-Example", "type": "searchset", "total": 0, "link": [ { "relation": "self", "url": "https:baseurl/Flag?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9000000009" } ] }
Example - A removed FGM flag
Important: This page is under development by NHS England
<Flag xmlns="http://hl7.org/fhir"> <id value="FGM-RemovedFlag-Example" /> <extension url="https://fhir.nhs.uk/StructureDefinition/Extension-England-FGMRemovalReason"> <valueCodeableConcept> <coding> <system value="https://fhir.nhs.uk/CodeSystem/England-FGMRemovalReason" /> <code value="0" /> <display value="Added in error - this child does not have a family history of FGM" /> </coding> </valueCodeableConcept> </extension> <status value="entered-in-error" /> <code> <coding> <system value="http://snomed.info/sct" /> <code value="902961000000107" /> <display value="Family history of FGM (female genital mutilation)" /> </coding> <text value="Family history of FGM (female genital mutilation)" /> </code> <subject> <identifier> <system value="https://fhir.nhs.uk/Id/nhs-number" /> <value value="9000000009" /> </identifier> </subject> </Flag>
{ "resourceType": "Flag", "id": "FGM-RemovedFlag-Example", "extension": [ { "url": "https://fhir.nhs.uk/StructureDefinition/Extension-England-FGMRemovalReason", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/England-FGMRemovalReason", "code": "0", "display": "Added in error - this child does not have a family history of FGM" } ] } } ], "status": "entered-in-error", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "902961000000107", "display": "Family history of FGM (female genital mutilation)" } ], "text": "Family history of FGM (female genital mutilation)" }, "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9000000009" } } }