Patient Flag Implementation Guide

WARNING

This guidance is under active development by NHS England and content may be added or updated on a regular basis.

This FHIR IG is ahead of the current PatientFlag API specification build. Please refer to that document for technical build and integration requirements, and to the PatientFlag programme for roadmap information.

RemoveFGMRecord-Bundle-Example

Table View

Bundle.id[0]	RemoveFGMRecord-Bundle-Example
Bundle.type[0]	transaction
Bundle.entry[0].fullUrl[0]	Flag/FGM-PatientFlag-Example
Bundle.entry[0].resource[0].id[0]	FGM-PatientFlag-Example
Bundle.entry[0].resource[0].meta[0].profile[0]	https://fhir.nhs.uk/England/StructureDefinition/England-Flag-PatientFlag
Bundle.entry[0].resource[0].contained[0].id[0]	c4e2e862-3bf4-4176-a186-9f1732938260
Bundle.entry[0].resource[0].contained[0].meta[0].profile[0]	https://fhir.nhs.uk/England/StructureDefinition/England-Provenance-Flag
Bundle.entry[0].resource[0].contained[0].target[0].reference[0]	#
Bundle.entry[0].resource[0].contained[0].recorded[0]	2024-01-01T11:00:00+00:00
Bundle.entry[0].resource[0].contained[0].activity[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-DataOperation
Bundle.entry[0].resource[0].contained[0].activity[0].coding[0].code[0]	CREATE
Bundle.entry[0].resource[0].contained[0].activity[0].coding[0].display[0]	create
Bundle.entry[0].resource[0].contained[0].agent[0].role[0].coding[0].system[0]	https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
Bundle.entry[0].resource[0].contained[0].agent[0].role[0].coding[0].code[0]	R0260
Bundle.entry[0].resource[0].contained[0].agent[0].role[0].coding[0].display[0]	General Medical Practitioner
Bundle.entry[0].resource[0].contained[0].agent[0].who[0].reference[0]	https://sds.spineservices.nhs.uk/Practitioner/2ee4tr6a9
Bundle.entry[0].resource[0].contained[0].agent[0].onBehalfOf[0].reference[0]	https://directory.spineservices.nhs.uk/Organization/a3e5i7
Bundle.entry[0].resource[0].extension[0].url[0]	https://fhir.nhs.uk/England/StructureDefinition/Extension-FlagNotes
Bundle.entry[0].resource[0].extension[0].value[0].text[0]	Example of flag notes extension text in patient flag
Bundle.entry[0].resource[0].status[0]	active
Bundle.entry[0].resource[0].code[0].coding[0].system[0]	https://fhir.nhs.uk/England/CodeSystem/England-FlagCategoryPatient
Bundle.entry[0].resource[0].code[0].coding[0].code[0]	female-genital-mutilation-flag
Bundle.entry[0].resource[0].code[0].coding[0].display[0]	Female Genital Mutilation Flag
Bundle.entry[0].resource[0].subject[0].reference[0]	Patient/PatientFlag-AlanMann-Example
Bundle.entry[0].request[0].method[0]	DELETE
Bundle.entry[0].request[0].url[0]	Flag/FGM-PatientFlag-Example

Tree View

Bundle

id : RemoveFGMRecord-Bundle-Example

type : transaction

entry

fullUrl : Flag/FGM-PatientFlag-Example

resource

id : FGM-PatientFlag-Example

meta

profile : https://fhir.nhs.uk/England/StructureDefinition/England-Flag-PatientFlag

contained

id : c4e2e862-3bf4-4176-a186-9f1732938260

meta

profile : https://fhir.nhs.uk/England/StructureDefinition/England-Provenance-Flag

target

reference : #

recorded : 2024-01-01T11:00:00+00:00

activity

coding

system : http://terminology.hl7.org/CodeSystem/v3-DataOperation

code : CREATE

display : create

agent

role

coding

system : https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1

code : R0260

display : General Medical Practitioner

who

reference : https://sds.spineservices.nhs.uk/Practitioner/2ee4tr6a9

onBehalfOf

reference : https://directory.spineservices.nhs.uk/Organization/a3e5i7

extension

url : https://fhir.nhs.uk/England/StructureDefinition/Extension-FlagNotes

value

text : Example of flag notes extension text in patient flag

status : active

code

coding

system : https://fhir.nhs.uk/England/CodeSystem/England-FlagCategoryPatient

code : female-genital-mutilation-flag

display : Female Genital Mutilation Flag

subject

reference : Patient/PatientFlag-AlanMann-Example

request

method : DELETE

url : Flag/FGM-PatientFlag-Example

XML View

<Bundle xmlns="http://hl7.org/fhir">
    <id value="RemoveFGMRecord-Bundle-Example" />
    <type value="transaction" />
    <entry>
        <fullUrl value="Flag/FGM-PatientFlag-Example" />
        <resource>
            <Flag>
                <id value="FGM-PatientFlag-Example" />
                <meta>
                    <profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Flag-PatientFlag" />
                </meta>
                <contained>
                    <Provenance>
                        <id value="c4e2e862-3bf4-4176-a186-9f1732938260" />
                        <meta>
                            <profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Provenance-Flag" />
                        </meta>
                        <target>
                            <reference value="#" />
                        </target>
                        <recorded value="2024-01-01T11:00:00+00:00" />
                        <activity>
                            <coding>
                                <system value="http://terminology.hl7.org/CodeSystem/v3-DataOperation" />
                                <code value="CREATE" />
                                <display value="create" />
                            </coding>
                        </activity>
                        <agent>
                            <role>
                                <coding>
                                    <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1" />
                                    <code value="R0260" />
                                    <display value="General Medical Practitioner" />
                                </coding>
                            </role>
                            <who>
                                <reference value="https://sds.spineservices.nhs.uk/Practitioner/2ee4tr6a9" />
                            </who>
                            <onBehalfOf>
                                <reference value="https://directory.spineservices.nhs.uk/Organization/a3e5i7" />
                            </onBehalfOf>
                        </agent>
                    </Provenance>
                </contained>
                <extension url="https://fhir.nhs.uk/England/StructureDefinition/Extension-FlagNotes">
                    <valueAnnotation>
                        <text value="Example of flag notes extension text in patient flag" />
                    </valueAnnotation>
                </extension>
                <status value="active" />
                <code>
                    <coding>
                        <system value="https://fhir.nhs.uk/England/CodeSystem/England-FlagCategoryPatient" />
                        <code value="female-genital-mutilation-flag" />
                        <display value="Female Genital Mutilation Flag" />
                    </coding>
                </code>
                <subject>
                    <reference value="Patient/PatientFlag-AlanMann-Example" />
                </subject>
            </Flag>
        </resource>
        <request>
            <method value="DELETE" />
            <url value="Flag/FGM-PatientFlag-Example" />
        </request>
    </entry>
</Bundle>

JSON View

{
    "resourceType": "Bundle",
    "id": "RemoveFGMRecord-Bundle-Example",
    "type": "transaction",
    "entry":  [
        {
            "fullUrl": "Flag/FGM-PatientFlag-Example",
            "resource": {
                "resourceType": "Flag",
                "id": "FGM-PatientFlag-Example",
                "meta": {
                    "profile":  [
                        "https://fhir.nhs.uk/England/StructureDefinition/England-Flag-PatientFlag"
                    ]
                },
                "contained":  [
                    {
                        "resourceType": "Provenance",
                        "id": "c4e2e862-3bf4-4176-a186-9f1732938260",
                        "meta": {
                            "profile":  [
                                "https://fhir.nhs.uk/England/StructureDefinition/England-Provenance-Flag"
                            ]
                        },
                        "target":  [
                            {
                                "reference": "#"
                            }
                        ],
                        "recorded": "01/01/2024 11:00:00",
                        "activity": {
                            "coding":  [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-DataOperation",
                                    "code": "CREATE",
                                    "display": "create"
                                }
                            ]
                        },
                        "agent":  [
                            {
                                "role":  [
                                    {
                                        "coding":  [
                                            {
                                                "system": "https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1",
                                                "code": "R0260",
                                                "display": "General Medical Practitioner"
                                            }
                                        ]
                                    }
                                ],
                                "who": {
                                    "reference": "https://sds.spineservices.nhs.uk/Practitioner/2ee4tr6a9"
                                },
                                "onBehalfOf": {
                                    "reference": "https://directory.spineservices.nhs.uk/Organization/a3e5i7"
                                }
                            }
                        ]
                    }
                ],
                "extension":  [
                    {
                        "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-FlagNotes",
                        "valueAnnotation": {
                            "text": "Example of flag notes extension text in patient flag"
                        }
                    }
                ],
                "status": "active",
                "code": {
                    "coding":  [
                        {
                            "system": "https://fhir.nhs.uk/England/CodeSystem/England-FlagCategoryPatient",
                            "code": "female-genital-mutilation-flag",
                            "display": "Female Genital Mutilation Flag"
                        }
                    ]
                },
                "subject": {
                    "reference": "Patient/PatientFlag-AlanMann-Example"
                }
            },
            "request": {
                "method": "DELETE",
                "url": "Flag/FGM-PatientFlag-Example"
            }
        }
    ]
}