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/FlagProvenance | Version: 0.4.0 | |||
| Draft as of 2024-02-14 | Computable Name: FlagProvenance | |||
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 details of the practitioner recording or removing an individual Flag.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Provenance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Provenance |
Provenance | |||
  target |
1..* | Reference(NHSE Condition Profile for flags | NHSE Programme Flag Profile | NHSE Patient Flag Profile) | Target Reference(s) (usually version specific) | |
  agent |
||||
 role |
0..* | CodeableConcept | What the agents role was Binding: NHSE Flag Provenance Role (extensible) | |
| who |
1..1 | Reference(Practitioner) | Who participated | |
 onBehalfOf |
0..1 | Reference(Organization) | Who the agent is representing | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Provenance.agent.role | extensible | FlagProvenanceRolehttps://fhir.nhs.uk/England/ValueSet/FlagProvenanceRolefrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| target |
Σ | 1..* | Reference(NHSE Condition Profile for flags | NHSE Programme Flag Profile | NHSE Patient Flag Profile) | Target Reference(s) (usually version specific) |
| recorded |
Σ | 1..1 | instant | When the activity was recorded / updated |
 agent |
1..* | BackboneElement | Actor involved | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
0..* | CodeableConcept | What the agents role was Binding: NHSE Flag Provenance Role (extensible) | |
| who |
Σ | 1..1 | Reference(Practitioner) | Who participated |
| onBehalfOf |
0..1 | Reference(Organization) | Who the agent is representing | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Provenance.agent.role | extensible | FlagProvenanceRolehttps://fhir.nhs.uk/England/ValueSet/FlagProvenanceRolefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Provenance | 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 | Provenance | 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 | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Provenance | 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 | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |||||
| 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 | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| target |
Σ | 1..* | Reference(NHSE Condition Profile for flags | NHSE Programme Flag Profile | NHSE Patient Flag Profile) | Target Reference(s) (usually version specific) | ||||
  occurred[x] |
0..1 | When the activity occurred | ||||||
 occurredPeriod |
Period | |||||||
| occurredDateTime |
dateTime | |||||||
| recorded |
Σ | 1..1 | instant | When the activity was recorded / updated | ||||
| policy |
0..* | uri | Policy or plan the activity was defined by | |||||
| location |
0..1 | Reference(Location) | Where the activity occurred, if relevant | |||||
| reason |
0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
| activity |
0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. | |||||
| agent |
1..* | BackboneElement | Actor involved | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. | ||||
| role |
0..* | CodeableConcept | What the agents role was Binding: NHSE Flag Provenance Role (extensible) | |||||
| who |
Σ | 1..1 | Reference(Practitioner) | Who participated | ||||
| onBehalfOf |
0..1 | Reference(Organization) | Who the agent is representing | |||||
| entity |
0..* | BackboneElement | An entity used in this activity | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | ||||
| what |
Σ | 1..1 | Reference(Resource) | Identity of entity | ||||
| agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| signature |
0..* | Signature | Signature on target | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Provenance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Provenance.reason | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Provenance.activity | extensible | ProvenanceActivityTypehttp://hl7.org/fhir/ValueSet/provenance-activity-typefrom the FHIR Standard | ||||
| Provenance.agent.type | extensible | ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-typefrom the FHIR Standard | ||||
| Provenance.agent.role | extensible | FlagProvenanceRolehttps://fhir.nhs.uk/England/ValueSet/FlagProvenanceRolefrom this IG | ||||
| Provenance.entity.role | required | ProvenanceEntityRolehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Provenance | 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 | Provenance | 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 | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Provenance | 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() |
This structure is derived from Provenance
Differential View
This structure is derived from Provenance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance |
Provenance | |||
| target |
1..* | Reference(NHSE Condition Profile for flags | NHSE Programme Flag Profile | NHSE Patient Flag Profile) | Target Reference(s) (usually version specific) | |
| agent |
||||
| role |
0..* | CodeableConcept | What the agents role was Binding: NHSE Flag Provenance Role (extensible) | |
| who |
1..1 | Reference(Practitioner) | Who participated | |
| onBehalfOf |
0..1 | Reference(Organization) | Who the agent is representing | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Provenance.agent.role | extensible | FlagProvenanceRolehttps://fhir.nhs.uk/England/ValueSet/FlagProvenanceRolefrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| target |
Σ | 1..* | Reference(NHSE Condition Profile for flags | NHSE Programme Flag Profile | NHSE Patient Flag Profile) | Target Reference(s) (usually version specific) |
| recorded |
Σ | 1..1 | instant | When the activity was recorded / updated |
| agent |
1..* | BackboneElement | Actor involved | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
0..* | CodeableConcept | What the agents role was Binding: NHSE Flag Provenance Role (extensible) | |
| who |
Σ | 1..1 | Reference(Practitioner) | Who participated |
| onBehalfOf |
0..1 | Reference(Organization) | Who the agent is representing | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Provenance.agent.role | extensible | FlagProvenanceRolehttps://fhir.nhs.uk/England/ValueSet/FlagProvenanceRolefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Provenance | 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 | Provenance | 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 | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Provenance | 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 | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| target |
Σ | 1..* | Reference(NHSE Condition Profile for flags | NHSE Programme Flag Profile | NHSE Patient Flag Profile) | Target Reference(s) (usually version specific) | ||||
| occurred[x] |
0..1 | When the activity occurred | ||||||
| occurredPeriod |
Period | |||||||
| occurredDateTime |
dateTime | |||||||
| recorded |
Σ | 1..1 | instant | When the activity was recorded / updated | ||||
| policy |
0..* | uri | Policy or plan the activity was defined by | |||||
| location |
0..1 | Reference(Location) | Where the activity occurred, if relevant | |||||
| reason |
0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
| activity |
0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. | |||||
| agent |
1..* | BackboneElement | Actor involved | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. | ||||
| role |
0..* | CodeableConcept | What the agents role was Binding: NHSE Flag Provenance Role (extensible) | |||||
| who |
Σ | 1..1 | Reference(Practitioner) | Who participated | ||||
| onBehalfOf |
0..1 | Reference(Organization) | Who the agent is representing | |||||
| entity |
0..* | BackboneElement | An entity used in this activity | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | ||||
| what |
Σ | 1..1 | Reference(Resource) | Identity of entity | ||||
| agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| signature |
0..* | Signature | Signature on target | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Provenance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Provenance.reason | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Provenance.activity | extensible | ProvenanceActivityTypehttp://hl7.org/fhir/ValueSet/provenance-activity-typefrom the FHIR Standard | ||||
| Provenance.agent.type | extensible | ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-typefrom the FHIR Standard | ||||
| Provenance.agent.role | extensible | FlagProvenanceRolehttps://fhir.nhs.uk/England/ValueSet/FlagProvenanceRolefrom this IG | ||||
| Provenance.entity.role | required | ProvenanceEntityRolehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Provenance | 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 | Provenance | 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 | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Provenance | 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() |
This structure is derived from Provenance
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
