Copy of 'GP Connect Data Model | FHIR STU3 Representation'

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

Profile: CareConnect-Flag-1

Command 'tree' could not render: Resource was not found for 'canonical=https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Flag-1'
Command 'dict' could not render: Resource was not found for 'canonical=https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Flag-1'
Command 'xml' could not render: Resource was not found for 'canonical=https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Flag-1'
Command 'json' could not render: Resource was not found for 'canonical=https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Flag-1'
Command 'details' could not render: There is no placeholder called 'details'

Reference

Canonical URI: https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Flag-1

The canonical URI is the stable FHIR identifier for this profile and is not currently available as a browsable web page.

Data Model Element Usage

Element Use CareConnect (STU3) UK Core (R4) NHS Digital (R4)
identifier
status
category
code
subject
period
encounter
author

Identifier

Usage

Mandatory

Guidance

The identifier element MUST be populated with a globally unique and persistent identifier (that is, it doesn’t change between requests and therefore stored with the source data). This MUST be scoped by a provider specific namespace for the identifier.

Where consuming systems are integrating data from this resource to their local system, they MUST also persist this identifier at the same time.

Example
<identifier>
    <system value="https://foo.bar/id/flag" />
    <value value="782bdd5a-9c18-4454-aea8-0a23f8355873" />
</identifier>

status

status

Usage

Mandatory

Guidance
  • Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or entered in error.

https://simplifier.net/packages/hl7.fhir.r3.core/3.0.2/files/62203

Example
<status value="active" />

category

Usage

Optional

Guidance

Allows an flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context

Example
<category>
    <coding>
        <system value="https://simplifier.net/packages/hl7.fhir.r3.core/3.0.2/files/59615" />
        <code value="admin" />
        <display value="Administrative" />
    </coding>
</category>

code

Usage

Mandatory

Guidance
  • The coded value or textual component of the flag to display to the user.
Example
<code>
    <coding>
        <system value="http://hl7.org/fhir/ValueSet/flag-code" />
        <code value="404684003" />
    </coding>
</code>

subject

Usage

Mandatory

Guidance

A reference to the subject matter for which the Flag relates to.

  • Reference can be any of the following - (Group | PlanDefinition | Procedure | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-Location-1 | CareConnect-Medication-1)

Command 'pagelink' could not render: Page not found.

Example
<subject>
	<identifier>
		<extension
			url="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1">
			<valueCodeableConcept>
				<coding>
					<system
						value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1" />
					<code value="01" />
					<display value="Number present and verified" />
				</coding>
				<text value="Number present and verified" />
			</valueCodeableConcept>
		</extension>
		<system value="https://fhir.nhs.uk/Id/nhs-number" />
		<value value="9989453456" />
	</identifier>
</subject> >

period

Usage

Required

Guidance

The period element is a required element which means it MUST be populated with values when they are known to the provider system.

  • The period.start represents the date and time when the consultation started.
  • The period.end reperesents the date when populated and the duration is known.
Example
<period>
    <start value="2022-10-28T13:38:00+00:00" />
    <end value="2022-10-28T13:53:00+00:00" />
</period>

encounter

Usage

Optional

TODO: This should be a 'MUST SUPPORT' / 'Required' element.
Guidance

For lists used in consultations

Mandatory reference to the Encounter profile providing the context for the consultation (Date/Doctor/Place ….)

The Encounter reference is provided by all Lists in the structure rather than the top-level List(Consultation) only.

Example
<encounter>
    <reference value="encounter-12iaq" />
</encounter>

author

Usage

Required

Guidance

Who and/or what authored the flag.

  • Command 'pagelink' could not render: Page not found.
  • Command 'pagelink' could not render: Page not found.
  • Command 'pagelink' could not render: Page not found.
  • Command 'pagelink' could not render: Page not found.
Example
<author>
    <reference value="practitioner-9929alp" />
</author>
back to top