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.

It is NOT currently recommended to develop against this guidance.

England FlagCategory

Description
Search by category in the Flag resource

HTML View

Invocations

[base]/Flag?category=[system]|[value]

Details

Resource	Code	Type	FhirPath
Flag	category	token	Flag.category

Table View

SearchParameter.id[0]	England-FlagCategory
SearchParameter.url[0]	https://fhir.nhs.uk/England/SearchParameter/England-FlagCategory
SearchParameter.version[0]	0.4.0
SearchParameter.name[0]	EnglandFlagCategory
SearchParameter.status[0]	active
SearchParameter.date[0]	2024-02-14
SearchParameter.publisher[0]	NHS England
SearchParameter.contact[0].name[0]	NHS England
SearchParameter.contact[0].telecom[0].system[0]	email
SearchParameter.contact[0].telecom[0].value[0]	interoperabilityteam@nhs.net
SearchParameter.contact[0].telecom[0].use[0]	work
SearchParameter.contact[0].telecom[0].rank[0]	1
SearchParameter.description[0]	Search by category in the Flag resource
SearchParameter.code[0]	category
SearchParameter.base[0]	Flag
SearchParameter.type[0]	token
SearchParameter.expression[0]	Flag.category
SearchParameter.xpathUsage[0]	normal

XML View

<SearchParameter xmlns="http://hl7.org/fhir">
    <id value="England-FlagCategory" />
    <url value="https://fhir.nhs.uk/England/SearchParameter/England-FlagCategory" />
    <version value="0.4.0" />
    <name value="EnglandFlagCategory" />
    <status value="active" />
    <date value="2024-02-14" />
    <publisher value="NHS England" />
    <contact>
        <name value="NHS England" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="Search by category in the Flag resource" />
    <code value="category" />
    <base value="Flag" />
    <type value="token" />
    <expression value="Flag.category" />
    <xpathUsage value="normal" />
</SearchParameter>

JSON View

{
    "resourceType": "SearchParameter",
    "id": "England-FlagCategory",
    "url": "https://fhir.nhs.uk/England/SearchParameter/England-FlagCategory",
    "version": "0.4.0",
    "name": "EnglandFlagCategory",
    "status": "active",
    "date": "2024-02-14",
    "publisher": "NHS England",
    "contact":  [
        {
            "name": "NHS England",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "Search by category in the Flag resource",
    "code": "category",
    "base":  [
        "Flag"
    ],
    "type": "token",
    "expression": "Flag.category",
    "xpathUsage": "normal"
}

Feedback

Click here to:

Report issue for England-FlagCategory

England FlagCode

Description
Search by code in the Flag resource

HTML View

Invocations

[base]/Flag?code=[system]|[value]

Details

Resource	Code	Type	FhirPath
Flag	code	token	Flag.code

Table View

SearchParameter.id[0]	England-FlagCode
SearchParameter.url[0]	https://fhir.nhs.uk/England/SearchParameter/England-FlagCode
SearchParameter.version[0]	0.1.0
SearchParameter.name[0]	EnglandFlagCode
SearchParameter.status[0]	draft
SearchParameter.experimental[0]	False
SearchParameter.date[0]	2024-02-14
SearchParameter.publisher[0]	NHS England
SearchParameter.contact[0].name[0]	NHS England
SearchParameter.contact[0].telecom[0].system[0]	email
SearchParameter.contact[0].telecom[0].value[0]	interoperabilityteam@nhs.net
SearchParameter.contact[0].telecom[0].use[0]	work
SearchParameter.contact[0].telecom[0].rank[0]	1
SearchParameter.description[0]	Search by code in the Flag resource
SearchParameter.code[0]	code
SearchParameter.base[0]	Flag
SearchParameter.type[0]	token
SearchParameter.expression[0]	Flag.code
SearchParameter.xpathUsage[0]	normal

XML View

<SearchParameter xmlns="http://hl7.org/fhir">
    <id value="England-FlagCode" />
    <url value="https://fhir.nhs.uk/England/SearchParameter/England-FlagCode" />
    <version value="0.1.0" />
    <name value="EnglandFlagCode" />
    <status value="draft" />
    <experimental value="false" />
    <date value="2024-02-14" />
    <publisher value="NHS England" />
    <contact>
        <name value="NHS England" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="Search by code in the Flag resource" />
    <code value="code" />
    <base value="Flag" />
    <type value="token" />
    <expression value="Flag.code" />
    <xpathUsage value="normal" />
</SearchParameter>

JSON View

{
    "resourceType": "SearchParameter",
    "id": "England-FlagCode",
    "url": "https://fhir.nhs.uk/England/SearchParameter/England-FlagCode",
    "version": "0.1.0",
    "name": "EnglandFlagCode",
    "status": "draft",
    "experimental": false,
    "date": "2024-02-14",
    "publisher": "NHS England",
    "contact":  [
        {
            "name": "NHS England",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "Search by code in the Flag resource",
    "code": "code",
    "base":  [
        "Flag"
    ],
    "type": "token",
    "expression": "Flag.code",
    "xpathUsage": "normal"
}

Feedback

Click here to:

Report issue for England-FlagCode

England FlagDetail

Description
Search for Condition, Flag or Consent resources referenced in flag detail extension

HTML View

Invocations

[base]/Flag?detail=Condition/[id]
[base]/Flag?detail=Flag/[id]

Details

Resource	Code	Type	FhirPath
Flag	detail	reference	Flag.extension('http://hl7.org/fhir/StructureDefinition/flag-detail')

Table View

SearchParameter.id[0]	England-FlagDetail
SearchParameter.url[0]	https://fhir.nhs.uk/England/SearchParameter/England-FlagDetail
SearchParameter.version[0]	0.4.0
SearchParameter.name[0]	EnglandFlagDetail
SearchParameter.status[0]	active
SearchParameter.date[0]	2024-02-14
SearchParameter.publisher[0]	NHS England
SearchParameter.contact[0].name[0]	NHS England
SearchParameter.contact[0].telecom[0].system[0]	email
SearchParameter.contact[0].telecom[0].value[0]	interoperabilityteam@nhs.net
SearchParameter.contact[0].telecom[0].use[0]	work
SearchParameter.contact[0].telecom[0].rank[0]	1
SearchParameter.description[0]	Search for Condition, Flag or Consent resources referenced in flag detail extension
SearchParameter.code[0]	detail
SearchParameter.base[0]	Flag
SearchParameter.type[0]	reference
SearchParameter.expression[0]	Flag.extension('http://hl7.org/fhir/StructureDefinition/flag-detail')
SearchParameter.target[0]	Condition
SearchParameter.target[1]	Flag

XML View

<SearchParameter xmlns="http://hl7.org/fhir">
    <id value="England-FlagDetail" />
    <url value="https://fhir.nhs.uk/England/SearchParameter/England-FlagDetail" />
    <version value="0.4.0" />
    <name value="EnglandFlagDetail" />
    <status value="active" />
    <date value="2024-02-14" />
    <publisher value="NHS England" />
    <contact>
        <name value="NHS England" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="Search for Condition, Flag or Consent resources referenced in flag detail extension" />
    <code value="detail" />
    <base value="Flag" />
    <type value="reference" />
    <expression value="Flag.extension(&#39;http://hl7.org/fhir/StructureDefinition/flag-detail&#39;)" />
    <target value="Condition" />
    <target value="Flag" />
</SearchParameter>

JSON View

{
    "resourceType": "SearchParameter",
    "id": "England-FlagDetail",
    "url": "https://fhir.nhs.uk/England/SearchParameter/England-FlagDetail",
    "version": "0.4.0",
    "name": "EnglandFlagDetail",
    "status": "active",
    "date": "2024-02-14",
    "publisher": "NHS England",
    "contact":  [
        {
            "name": "NHS England",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "Search for Condition, Flag or Consent resources referenced in flag detail extension",
    "code": "detail",
    "base":  [
        "Flag"
    ],
    "type": "reference",
    "expression": "Flag.extension('http://hl7.org/fhir/StructureDefinition/flag-detail')",
    "target":  [
        "Condition",
        "Flag"
    ]
}

Feedback

Click here to:

Report issue for England-FlagDetail