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.

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, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,