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.

RA-Condition2-Example

Table View

Condition.id[0]	RA-Condition2-Example
Condition.meta[0].profile[0]	https://fhir.nhs.uk/England/StructureDefinition/England-Condition-Flag
Condition.contained[0].id[0]	f55e1edc-8ac7-4e06-b322-25fd34e62249
Condition.contained[0].meta[0].profile[0]	https://fhir.nhs.uk/England/StructureDefinition/England-Provenance-Flag
Condition.contained[0].target[0].reference[0]	#
Condition.contained[0].recorded[0]	2024-01-01T11:00:00+00:00
Condition.contained[0].activity[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-DataOperation
Condition.contained[0].activity[0].coding[0].code[0]	CREATE
Condition.contained[0].activity[0].coding[0].display[0]	create
Condition.contained[0].agent[0].role[0].coding[0].system[0]	https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
Condition.contained[0].agent[0].role[0].coding[0].code[0]	R0260
Condition.contained[0].agent[0].role[0].coding[0].display[0]	General Medical Practitioner
Condition.contained[0].agent[0].who[0].reference[0]	https://sds.spineservices.nhs.uk/Practitioner/2ee4tr6a9
Condition.contained[0].agent[0].onBehalfOf[0].reference[0]	https://directory.spineservices.nhs.uk/Organization/a3e5i7
Condition.clinicalStatus[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/condition-clinical
Condition.clinicalStatus[0].coding[0].code[0]	active
Condition.category[0].coding[0].system[0]	https://fhir.nhs.uk/England/CodeSystem/England-FlagCategoryPatient
Condition.category[0].coding[0].code[0]	national-reasonable-adjustment-flag
Condition.category[0].coding[0].display[0]	National Reasonable Adjustments Flag
Condition.category[1].coding[0].system[0]	https://fhir.nhs.uk/England/CodeSystem/England-ConditionCategoryRA
Condition.category[1].coding[0].code[0]	issue
Condition.category[1].coding[0].display[0]	Issue
Condition.code[0].coding[0].system[0]	https://fhir.nhs.uk/England/CodeSystem/England-ConditionCodeRA
Condition.code[0].coding[0].code[0]	social
Condition.code[0].coding[0].display[0]	Social or behavioural (for example associated with autism spectrum disorder (ASD) which includes Asperger’s, or attention deficit hyperactivity disorder (ADHD))
Condition.subject[0].reference[0]	Patient/PatientFlag-AlanMann-Example

Tree View

Condition

id : RA-Condition2-Example

meta

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

contained

id : f55e1edc-8ac7-4e06-b322-25fd34e62249

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

clinicalStatus

coding

system : http://terminology.hl7.org/CodeSystem/condition-clinical

code : active

category

coding

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

code : national-reasonable-adjustment-flag

display : National Reasonable Adjustments Flag

category

coding

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

code : issue

display : Issue

code

coding

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

code : social

display : Social or behavioural (for example associated with autism spectrum disorder (ASD) which includes Asperger’s, or attention deficit hyperactivity disorder (ADHD))

subject

reference : Patient/PatientFlag-AlanMann-Example

XML View

<Condition xmlns="http://hl7.org/fhir">
    <id value="RA-Condition2-Example" />
    <meta>
        <profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Condition-Flag" />
    </meta>
    <contained>
        <Provenance>
            <id value="f55e1edc-8ac7-4e06-b322-25fd34e62249" />
            <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>
    <clinicalStatus>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/condition-clinical" />
            <code value="active" />
        </coding>
    </clinicalStatus>
    <category>
        <coding>
            <system value="https://fhir.nhs.uk/England/CodeSystem/England-FlagCategoryPatient" />
            <code value="national-reasonable-adjustment-flag" />
            <display value="National Reasonable Adjustments Flag" />
        </coding>
    </category>
    <category>
        <coding>
            <system value="https://fhir.nhs.uk/England/CodeSystem/England-ConditionCategoryRA" />
            <code value="issue" />
            <display value="Issue" />
        </coding>
    </category>
    <code>
        <coding>
            <system value="https://fhir.nhs.uk/England/CodeSystem/England-ConditionCodeRA" />
            <code value="social" />
            <display value="Social or behavioural (for example associated with autism spectrum disorder (ASD) which includes Asperger’s, or attention deficit hyperactivity disorder (ADHD))" />
        </coding>
    </code>
    <subject>
        <reference value="Patient/PatientFlag-AlanMann-Example" />
    </subject>
</Condition>

JSON View

{
    "resourceType": "Condition",
    "id": "RA-Condition2-Example",
    "meta": {
        "profile":  [
            "https://fhir.nhs.uk/England/StructureDefinition/England-Condition-Flag"
        ]
    },
    "contained":  [
        {
            "resourceType": "Provenance",
            "id": "f55e1edc-8ac7-4e06-b322-25fd34e62249",
            "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"
                    }
                }
            ]
        }
    ],
    "clinicalStatus": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
                "code": "active"
            }
        ]
    },
    "category":  [
        {
            "coding":  [
                {
                    "system": "https://fhir.nhs.uk/England/CodeSystem/England-FlagCategoryPatient",
                    "code": "national-reasonable-adjustment-flag",
                    "display": "National Reasonable Adjustments Flag"
                }
            ]
        },
        {
            "coding":  [
                {
                    "system": "https://fhir.nhs.uk/England/CodeSystem/England-ConditionCategoryRA",
                    "code": "issue",
                    "display": "Issue"
                }
            ]
        }
    ],
    "code": {
        "coding":  [
            {
                "system": "https://fhir.nhs.uk/England/CodeSystem/England-ConditionCodeRA",
                "code": "social",
                "display": "Social or behavioural (for example associated with autism spectrum disorder (ASD) which includes Asperger’s, or attention deficit hyperactivity disorder (ADHD))"
            }
        ]
    },
    "subject": {
        "reference": "Patient/PatientFlag-AlanMann-Example"
    }
}