Patient Flags - NHS England - Implementation Guide STU1
0.4.0 - ci-build
Patient Flags - NHS England - Implementation Guide STU1
0.4.0 - ci-build
Patient Flags - NHS England - Implementation Guide STU1 - Local Development build (v0.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.nhs.uk/England/StructureDefinition/ProgrammeFlag | Version: 0.4.0 | |||
| Draft as of 2024-02-14 | Computable Name: ProgrammeFlag | |||
Copyright/Legal: Copyright © 2024+ NHS England Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
||||
Record an individual flag for an NHS England programme.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Flag
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Flag |
Flag | |||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   flagNotes |
0..1 | Annotation | Extension for Flag Adjustment Notes URL: https://fhir.nhs.uk/England/StructureDefinition/Extension-FlagNotes | |
 Slices for category |
2..* | CodeableConcept | Clinical, administrative, etc. Slice: Unordered, Open by pattern:$this | |
 category:patientFlag |
S | 1..* | CodeableConcept | Clinical, administrative, etc. Binding: NHSE Patient Flag Category (required) |
| category:programmeFlag |
S | 1..* | CodeableConcept | Clinical, administrative, etc. Binding: NHSE Programme Flag Category (required) |
  code |
S | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: NHSE Programme Flag Code (extensible) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Flag.category:patientFlag | required | PatientFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/PatientFlagCategoryfrom this IG | |
| Flag.category:programmeFlag | required | ProgrammeFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/ProgrammeFlagCategoryfrom this IG | |
| Flag.code | extensible | ProgrammeFlagCodehttps://fhir.nhs.uk/England/ValueSet/ProgrammeFlagCodefrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Flag |
0..* | Flag | Key information to flag to healthcare providers | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| flagNotes |
0..1 | Annotation | Extension for Flag Adjustment Notes URL: https://fhir.nhs.uk/England/StructureDefinition/Extension-FlagNotes | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | active | inactive | entered-in-error Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error. |
| Slices for category |
Σ | 2..* | CodeableConcept | Clinical, administrative, etc. Slice: Unordered, Open by pattern:$this Binding: FlagCategory (example): A general category for flags for filtering/display purposes. |
| category:patientFlag |
SΣ | 1..* | CodeableConcept | Clinical, administrative, etc. Binding: NHSE Patient Flag Category (required) |
| category:programmeFlag |
SΣ | 1..* | CodeableConcept | Clinical, administrative, etc. Binding: NHSE Programme Flag Category (required) |
 code |
SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: NHSE Programme Flag Code (extensible) |
 subject |
Σ | 1..1 | Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) | Who/What is flag about? |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Flag.status | required | FlagStatushttp://hl7.org/fhir/ValueSet/flag-status|4.0.1from the FHIR Standard | |
| Flag.category | example | FlagCategoryhttp://hl7.org/fhir/ValueSet/flag-categoryfrom the FHIR Standard | |
| Flag.category:patientFlag | required | PatientFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/PatientFlagCategoryfrom this IG | |
| Flag.category:programmeFlag | required | ProgrammeFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/ProgrammeFlagCategoryfrom this IG | |
| Flag.code | extensible | ProgrammeFlagCodehttps://fhir.nhs.uk/England/ValueSet/ProgrammeFlagCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Flag | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Flag | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Flag |
0..* | Flag | Key information to flag to healthcare providers | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| flagNotes |
0..1 | Annotation | Extension for Flag Adjustment Notes URL: https://fhir.nhs.uk/England/StructureDefinition/Extension-FlagNotes | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier | ||||
| status |
?!Σ | 1..1 | code | active | inactive | entered-in-error Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error. | ||||
| Slices for category |
Σ | 2..* | CodeableConcept | Clinical, administrative, etc. Slice: Unordered, Open by pattern:$this Binding: FlagCategory (example): A general category for flags for filtering/display purposes. | ||||
| category:patientFlag |
SΣ | 1..* | CodeableConcept | Clinical, administrative, etc. Binding: NHSE Patient Flag Category (required) | ||||
| category:programmeFlag |
SΣ | 1..* | CodeableConcept | Clinical, administrative, etc. Binding: NHSE Programme Flag Category (required) | ||||
| code |
SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: NHSE Programme Flag Code (extensible) | ||||
| subject |
Σ | 1..1 | Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) | Who/What is flag about? | ||||
| period |
Σ | 0..1 | Period | Time period when flag is active | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Alert relevant during encounter | ||||
| author |
Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Flag.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Flag.status | required | FlagStatushttp://hl7.org/fhir/ValueSet/flag-status|4.0.1from the FHIR Standard | ||||
| Flag.category | example | FlagCategoryhttp://hl7.org/fhir/ValueSet/flag-categoryfrom the FHIR Standard | ||||
| Flag.category:patientFlag | required | PatientFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/PatientFlagCategoryfrom this IG | ||||
| Flag.category:programmeFlag | required | ProgrammeFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/ProgrammeFlagCategoryfrom this IG | ||||
| Flag.code | extensible | ProgrammeFlagCodehttps://fhir.nhs.uk/England/ValueSet/ProgrammeFlagCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Flag | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Flag | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Flag
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Flag |
Flag | |||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| flagNotes |
0..1 | Annotation | Extension for Flag Adjustment Notes URL: https://fhir.nhs.uk/England/StructureDefinition/Extension-FlagNotes | |
| Slices for category |
2..* | CodeableConcept | Clinical, administrative, etc. Slice: Unordered, Open by pattern:$this | |
| category:patientFlag |
S | 1..* | CodeableConcept | Clinical, administrative, etc. Binding: NHSE Patient Flag Category (required) |
| category:programmeFlag |
S | 1..* | CodeableConcept | Clinical, administrative, etc. Binding: NHSE Programme Flag Category (required) |
| code |
S | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: NHSE Programme Flag Code (extensible) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Flag.category:patientFlag | required | PatientFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/PatientFlagCategoryfrom this IG | |
| Flag.category:programmeFlag | required | ProgrammeFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/ProgrammeFlagCategoryfrom this IG | |
| Flag.code | extensible | ProgrammeFlagCodehttps://fhir.nhs.uk/England/ValueSet/ProgrammeFlagCodefrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Flag |
0..* | Flag | Key information to flag to healthcare providers | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| flagNotes |
0..1 | Annotation | Extension for Flag Adjustment Notes URL: https://fhir.nhs.uk/England/StructureDefinition/Extension-FlagNotes | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | active | inactive | entered-in-error Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error. |
| Slices for category |
Σ | 2..* | CodeableConcept | Clinical, administrative, etc. Slice: Unordered, Open by pattern:$this Binding: FlagCategory (example): A general category for flags for filtering/display purposes. |
| category:patientFlag |
SΣ | 1..* | CodeableConcept | Clinical, administrative, etc. Binding: NHSE Patient Flag Category (required) |
| category:programmeFlag |
SΣ | 1..* | CodeableConcept | Clinical, administrative, etc. Binding: NHSE Programme Flag Category (required) |
| code |
SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: NHSE Programme Flag Code (extensible) |
| subject |
Σ | 1..1 | Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) | Who/What is flag about? |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Flag.status | required | FlagStatushttp://hl7.org/fhir/ValueSet/flag-status|4.0.1from the FHIR Standard | |
| Flag.category | example | FlagCategoryhttp://hl7.org/fhir/ValueSet/flag-categoryfrom the FHIR Standard | |
| Flag.category:patientFlag | required | PatientFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/PatientFlagCategoryfrom this IG | |
| Flag.category:programmeFlag | required | ProgrammeFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/ProgrammeFlagCategoryfrom this IG | |
| Flag.code | extensible | ProgrammeFlagCodehttps://fhir.nhs.uk/England/ValueSet/ProgrammeFlagCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Flag | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Flag | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Flag |
0..* | Flag | Key information to flag to healthcare providers | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| flagNotes |
0..1 | Annotation | Extension for Flag Adjustment Notes URL: https://fhir.nhs.uk/England/StructureDefinition/Extension-FlagNotes | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier | ||||
| status |
?!Σ | 1..1 | code | active | inactive | entered-in-error Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error. | ||||
| Slices for category |
Σ | 2..* | CodeableConcept | Clinical, administrative, etc. Slice: Unordered, Open by pattern:$this Binding: FlagCategory (example): A general category for flags for filtering/display purposes. | ||||
| category:patientFlag |
SΣ | 1..* | CodeableConcept | Clinical, administrative, etc. Binding: NHSE Patient Flag Category (required) | ||||
| category:programmeFlag |
SΣ | 1..* | CodeableConcept | Clinical, administrative, etc. Binding: NHSE Programme Flag Category (required) | ||||
| code |
SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: NHSE Programme Flag Code (extensible) | ||||
| subject |
Σ | 1..1 | Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) | Who/What is flag about? | ||||
| period |
Σ | 0..1 | Period | Time period when flag is active | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Alert relevant during encounter | ||||
| author |
Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Flag.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Flag.status | required | FlagStatushttp://hl7.org/fhir/ValueSet/flag-status|4.0.1from the FHIR Standard | ||||
| Flag.category | example | FlagCategoryhttp://hl7.org/fhir/ValueSet/flag-categoryfrom the FHIR Standard | ||||
| Flag.category:patientFlag | required | PatientFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/PatientFlagCategoryfrom this IG | ||||
| Flag.category:programmeFlag | required | ProgrammeFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/ProgrammeFlagCategoryfrom this IG | ||||
| Flag.code | extensible | ProgrammeFlagCodehttps://fhir.nhs.uk/England/ValueSet/ProgrammeFlagCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Flag | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Flag | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Other representations of profile: CSV, Excel, Schematron
IG © Copyright © 2024+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. NHS England. Package patient-flags.stu1#0.4.0 based on FHIR 4.0.1. Generated 2024-07-02
