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.
StructureDefinition England-Condition-Flag
Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.nhs.uk/England/StructureDefinition/England-Condition-Flag | draft | 0.2.0 | 2024-06-18 | Record an individual condition for a flag in NHS England |
Profile_Purpose |
---|
This profile is made available to record an individual condition for a flag in NHS England |
Detailed Descriptions
Condition | |
Definition | A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Condition.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Condition.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Condition.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
Condition.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
Condition.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Condition.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 1...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Slicing | Unordered, Open, by $this(Type) |
Mappings |
|
Condition.contained:provenance | |
Definition | Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies. |
Cardinality | 1...1 |
Type | EnglandProvenanceFlag |
Alias | inline resources, anonymous resources, contained resources, History, Event, Activity |
Comments | Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance. |
Invariants |
|
Mappings |
|
Condition.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Condition.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Condition.identifier | |
Definition | Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Requirements | Allows identification of the condition as it is known by various participating systems and in a way that remains consistent across servers. |
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
Invariants |
|
Mappings |
|
Condition.clinicalStatus | |
Definition | The clinical status of the condition. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The clinical status of the condition or diagnosis. |
Modifier | True |
Summary | True |
Comments | The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. |
Invariants |
|
Mappings |
|
Condition.verificationStatus | |
Definition | The verification status to support the clinical status of the condition. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The verification status to support or decline the clinical status of the condition or diagnosis. |
Modifier | True |
Summary | True |
Comments | verificationStatus is not required. For example, when a patient has abdominal pain in the ED, there is not likely going to be a verification status. The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. |
Invariants |
|
Mappings |
|
Condition.category | |
Definition | A category assigned to the condition. |
Cardinality | 0...2 |
Type | CodeableConcept |
Binding | A category assigned to the condition. |
Comments | The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Condition.category:patientFlag | |
Definition | A category assigned to the condition. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A category assigned to the condition. |
Must Support | True |
Comments | The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts. |
Invariants |
|
Mappings |
|
Condition.category:conditionCategory | |
Definition | A category assigned to the condition. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A category assigned to the condition. |
Must Support | True |
Comments | The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts. |
Invariants |
|
Mappings |
|
Condition.severity | |
Definition | A subjective assessment of the severity of the condition as evaluated by the clinician. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A subjective assessment of the severity of the condition as evaluated by the clinician. |
Comments | Coding of the severity with a terminology is preferred, where possible. |
Invariants |
|
Mappings |
|
Condition.code | |
Definition | Identification of the condition, problem or diagnosis. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Identification of the condition or diagnosis. |
Must Support | True |
Summary | True |
Alias | type |
Requirements | 0..1 to account for primarily narrative only resources. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Condition.bodySite | |
Definition | The anatomical location where this condition manifests itself. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes describing anatomical locations. May include laterality. |
Summary | True |
Comments | Only used if not implicit in code found in Condition.code. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. |
Invariants |
|
Mappings |
|
Condition.subject | |
Definition | Indicates the patient or group who the condition record is associated with. |
Cardinality | 1...1 |
Type | Reference(Patient | Group) |
Summary | True |
Alias | patient |
Requirements | Group is typically used for veterinary or public health use cases. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Condition.encounter | |
Definition | The Encounter during which this Condition was created or to which the creation of this record is tightly associated. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Summary | True |
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. This record indicates the encounter this particular record is associated with. In the case of a "new" diagnosis reflecting ongoing/revised information about the condition, this might be distinct from the first encounter in which the underlying condition was first "known". |
Invariants |
|
Mappings |
|
Condition.onset[x] | |
Definition | Estimated or actual date or date-time the condition began, in the opinion of the clinician. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Comments | Age is generally used when the patient reports an age at which the Condition began to occur. |
Invariants |
|
Mappings |
|
Condition.abatement[x] | |
Definition | The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate. |
Cardinality | 0...1 |
Type | dateTime |
Comments | There is no explicit distinction between resolution and remission because in many cases the distinction is not clear. Age is generally used when the patient reports an age at which the Condition abated. If there is no abatement element, it is unknown whether the condition has resolved or entered remission; applications and users should generally assume that the condition is still valid. When abatementString exists, it implies the condition is abated. |
Invariants |
|
Mappings |
|
Condition.recordedDate | |
Definition | The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Invariants |
|
Mappings |
|
Condition.recorder | |
Definition | Individual who recorded the record and takes responsibility for its content. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Condition.asserter | |
Definition | Individual who is making the condition statement. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Condition.stage | |
Definition | Clinical stage or grade of a condition. May include formal severity assessments. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Condition.stage.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Condition.stage.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Condition.stage.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Condition.stage.summary | |
Definition | A simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes describing condition stages (e.g. Cancer stages). |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Condition.stage.assessment | |
Definition | Reference to a formal record of the evidence on which the staging assessment is based. |
Cardinality | 0...* |
Type | Reference(ClinicalImpression | DiagnosticReport | Observation) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Condition.stage.type | |
Definition | The kind of staging, such as pathological or clinical staging. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes describing the kind of condition staging (e.g. clinical or pathological). |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Condition.evidence | |
Definition | Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition. |
Cardinality | 0...* |
Type | BackboneElement |
Comments | The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both. |
Invariants |
|
Mappings |
|
Condition.evidence.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Condition.evidence.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Condition.evidence.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Condition.evidence.code | |
Definition | A manifestation or symptom that led to the recording of this condition. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes that describe the manifestation or symptoms of a condition. |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Condition.evidence.detail | |
Definition | Links to other relevant information, including pathology reports. |
Cardinality | 0...* |
Type | Reference(Resource) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Condition.note | |
Definition | Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis. |
Cardinality | 0...* |
Type | Annotation |
Comments | For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). |
Invariants |
|
Mappings |
|
Table View
Condition | .. | |
Condition.contained | 1.. | |
Condition.contained | EnglandProvenanceFlag | 1..1 |
Condition.category | ..2 | |
Condition.category | ..1 | |
Condition.category | ..1 | |
Condition.code | 1.. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="England-Condition-Flag" /> <url value="https://fhir.nhs.uk/England/StructureDefinition/England-Condition-Flag" /> <version value="0.2.0" /> <name value="EnglandConditionFlag" /> <title value="England Condition Flag" /> <status value="draft" /> <date value="2024-06-18" /> <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="Record an individual condition for a flag in NHS England" /> <purpose value="This profile is made available to record an individual condition for a flag in NHS England" /> <copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \&quot;License\&quot;); 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 \&quot;AS IS\&quot; 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." /> <fhirVersion value="4.0.1" /> <mapping> <identity value="workflow" /> <uri value="http://hl7.org/fhir/workflow" /> <name value="Workflow Pattern" /> </mapping> <mapping> <identity value="sct-concept" /> <uri value="http://snomed.info/conceptdomain" /> <name value="SNOMED CT Concept Domain Binding" /> </mapping> <mapping> <identity value="v2" /> <uri value="http://hl7.org/v2" /> <name value="HL7 v2 Mapping" /> </mapping> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <mapping> <identity value="w5" /> <uri value="http://hl7.org/fhir/fivews" /> <name value="FiveWs Pattern Mapping" /> </mapping> <mapping> <identity value="sct-attr" /> <uri value="http://snomed.org/attributebinding" /> <name value="SNOMED CT Attribute Binding" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Condition" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Condition" /> <derivation value="constraint" /> <differential> <element id="Condition.contained"> <path value="Condition.contained" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> </element> <element id="Condition.contained:provenance"> <path value="Condition.contained" /> <sliceName value="provenance" /> <min value="1" /> <max value="1" /> <type> <code value="Provenance" /> <profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Provenance-Flag" /> </type> </element> <element id="Condition.category"> <path value="Condition.category" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <max value="2" /> </element> <element id="Condition.category:patientFlag"> <path value="Condition.category" /> <sliceName value="patientFlag" /> <max value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://fhir.nhs.uk/England/ValueSet/England-FlagCategoryPatient" /> </binding> </element> <element id="Condition.category:conditionCategory"> <path value="Condition.category" /> <sliceName value="conditionCategory" /> <max value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://fhir.nhs.uk/England/ValueSet/England-FlagConditionCategory" /> </binding> </element> <element id="Condition.code"> <path value="Condition.code" /> <min value="1" /> <mustSupport value="true" /> <binding> <strength value="extensible" /> <valueSet value="https://fhir.nhs.uk/England/ValueSet/England-FlagConditionCode" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "England-Condition-Flag", "url": "https://fhir.nhs.uk/England/StructureDefinition/England-Condition-Flag", "version": "0.2.0", "name": "EnglandConditionFlag", "title": "England Condition Flag", "status": "draft", "date": "2024-06-18", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "Record an individual condition for a flag in NHS England", "purpose": "This profile is made available to record an individual condition for a flag in NHS England", "copyright": "Copyright © 2023+ 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.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "identity": "sct-concept", "uri": "http://snomed.info/conceptdomain", "name": "SNOMED CT Concept Domain Binding" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" }, { "identity": "sct-attr", "uri": "http://snomed.org/attributebinding", "name": "SNOMED CT Attribute Binding" } ], "kind": "resource", "abstract": false, "type": "Condition", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Condition", "derivation": "constraint", "differential": { "element": [ { "id": "Condition.contained", "path": "Condition.contained", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "open" }, "min": 1 }, { "id": "Condition.contained:provenance", "path": "Condition.contained", "sliceName": "provenance", "min": 1, "max": "1", "type": [ { "code": "Provenance", "profile": [ "https://fhir.nhs.uk/England/StructureDefinition/England-Provenance-Flag" ] } ] }, { "id": "Condition.category", "path": "Condition.category", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" }, "max": "2" }, { "id": "Condition.category:patientFlag", "path": "Condition.category", "sliceName": "patientFlag", "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-FlagCategoryPatient" } }, { "id": "Condition.category:conditionCategory", "path": "Condition.category", "sliceName": "conditionCategory", "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-FlagConditionCategory" } }, { "id": "Condition.code", "path": "Condition.code", "min": 1, "mustSupport": true, "binding": { "strength": "extensible", "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-FlagConditionCode" } } ] } }
Feedback
Click here to:Report issue for England-Condition-Flag, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
StructureDefinition England-Flag-PatientFlag-Adjustment
Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.nhs.uk/England/StructureDefinition/England-Flag-PatientFlag-Adjustment | draft | 0.1.0 | 2024-02-14 | Record an individual flag for an NHS England programme. |
Profile_Purpose |
---|
This profile is made available to record an individual flag for an NHS England programme. |
Detailed Descriptions
Flag | |
Definition | Prospective warnings of potential issues when providing care to the patient. |
Cardinality | 0...* |
Alias | Barriers to Care, Alert, Warning |
Invariants |
|
Mappings |
|
Flag.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Flag.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Flag.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
Flag.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
Flag.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Flag.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Flag.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Flag.extension:extensionEnglandFlagNotes | |
Definition | Captures the additional information for an adjustment within a Reasonable Adjustment Flag. |
Cardinality | 0...* |
Type | Extension(Annotation) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Flag.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Flag.identifier | |
Definition | Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Requirements | Allows identification of the flag as it is known by various participating systems and in a way that remains consistent across servers. |
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
Invariants |
|
Mappings |
|
Flag.status | |
Definition | Supports basic workflow. |
Cardinality | 1...1 |
Type | code |
Binding | 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. |
Modifier | True |
Summary | True |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Invariants |
|
Mappings |
|
Flag.category | |
Definition | Allows a 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. |
Cardinality | 2...* |
Type | CodeableConcept |
Binding | A general category for flags for filtering/display purposes. |
Summary | True |
Comments | The value set will often need to be adjusted based on local business rules and usage context. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Flag.category:patientFlag | |
Definition | Allows a 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. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A general category for flags for filtering/display purposes. |
Must Support | True |
Summary | True |
Comments | The value set will often need to be adjusted based on local business rules and usage context. |
Invariants |
|
Mappings |
|
Flag.category:programmeFlag | |
Definition | Allows a 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. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A general category for flags for filtering/display purposes. |
Must Support | True |
Summary | True |
Comments | The value set will often need to be adjusted based on local business rules and usage context. |
Invariants |
|
Mappings |
|
Flag.code | |
Definition | The coded value or textual component of the flag to display to the user. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Detail codes identifying specific flagged issues. |
Must Support | True |
Summary | True |
Comments | If non-coded, use CodeableConcept.text. This element should always be included in the narrative. |
Invariants |
|
Mappings |
|
Flag.subject | |
Definition | The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with. |
Cardinality | 1...1 |
Type | Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Flag.period | |
Definition | The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
Flag.encounter | |
Definition | This alert is only relevant during the encounter. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Summary | True |
Comments | If both Flag.encounter and Flag.period are valued, then Flag.period.start shall not be before Encounter.period.start and Flag.period.end shall not be after Encounter.period.end. |
Invariants |
|
Mappings |
|
Flag.author | |
Definition | The person, organization or device that created the flag. |
Cardinality | 0...1 |
Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Table View
Flag | .. | |
Flag.extension | Extension | .. |
Flag.category | 2.. | |
Flag.category | ..1 | |
Flag.category | ..1 | |
Flag.code | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="England-Flag-PatientFlag-Adjustment" /> <url value="https://fhir.nhs.uk/England/StructureDefinition/England-Flag-PatientFlag-Adjustment" /> <version value="0.1.0" /> <name value="EnglandFlagPatientFlagAdjustment" /> <title value="England Flag Patient Flag Adjustment" /> <status value="draft" /> <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="Record an individual flag for an NHS England programme." /> <purpose value="This profile is made available to record an individual flag for an NHS England programme." /> <copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \&quot;License\&quot;); 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 \&quot;AS IS\&quot; 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." /> <fhirVersion value="4.0.1" /> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <mapping> <identity value="w5" /> <uri value="http://hl7.org/fhir/fivews" /> <name value="FiveWs Pattern Mapping" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Flag" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Flag" /> <derivation value="constraint" /> <differential> <element id="Flag.extension:extensionEnglandFlagNotes"> <path value="Flag.extension" /> <sliceName value="extensionEnglandFlagNotes" /> <type> <code value="Extension" /> <profile value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-FlagNotes" /> </type> <isModifier value="false" /> </element> <element id="Flag.category"> <path value="Flag.category" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <min value="2" /> </element> <element id="Flag.category:patientFlag"> <path value="Flag.category" /> <sliceName value="patientFlag" /> <max value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://fhir.nhs.uk/England/ValueSet/England-FlagCategoryPatient" /> </binding> </element> <element id="Flag.category:programmeFlag"> <path value="Flag.category" /> <sliceName value="programmeFlag" /> <max value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://fhir.nhs.uk/England/ValueSet/England-FlagCategoryProgramme" /> </binding> </element> <element id="Flag.code"> <path value="Flag.code" /> <mustSupport value="true" /> <binding> <strength value="extensible" /> <valueSet value="https://fhir.nhs.uk/England/ValueSet/England-FlagCodeProgramme" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "England-Flag-PatientFlag-Adjustment", "url": "https://fhir.nhs.uk/England/StructureDefinition/England-Flag-PatientFlag-Adjustment", "version": "0.1.0", "name": "EnglandFlagPatientFlagAdjustment", "title": "England Flag Patient Flag Adjustment", "status": "draft", "date": "2024-02-14", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "Record an individual flag for an NHS England programme.", "purpose": "This profile is made available to record an individual flag for an NHS England programme.", "copyright": "Copyright © 2023+ 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.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" } ], "kind": "resource", "abstract": false, "type": "Flag", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Flag", "derivation": "constraint", "differential": { "element": [ { "id": "Flag.extension:extensionEnglandFlagNotes", "path": "Flag.extension", "sliceName": "extensionEnglandFlagNotes", "type": [ { "code": "Extension", "profile": [ "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-FlagNotes" ] } ], "isModifier": false }, { "id": "Flag.category", "path": "Flag.category", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" }, "min": 2 }, { "id": "Flag.category:patientFlag", "path": "Flag.category", "sliceName": "patientFlag", "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-FlagCategoryPatient" } }, { "id": "Flag.category:programmeFlag", "path": "Flag.category", "sliceName": "programmeFlag", "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-FlagCategoryProgramme" } }, { "id": "Flag.code", "path": "Flag.code", "mustSupport": true, "binding": { "strength": "extensible", "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-FlagCodeProgramme" } } ] } }
Feedback
Click here to:Report issue for England-Flag-PatientFlag-Adjustment, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
StructureDefinition England-Flag-PatientFlag
Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.nhs.uk/England/StructureDefinition/England-Flag-PatientFlag | draft | 0.2.0 | 2024-06-18 | Record whether a Patient Flags exists |
Profile_Purpose |
---|
This profile is made available to Record whether a Patient Flags exists . |
Detailed Descriptions
Flag | |
Definition | Prospective warnings of potential issues when providing care to the patient. |
Cardinality | 0...* |
Alias | Barriers to Care, Alert, Warning |
Invariants |
|
Mappings |
|
Flag.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Flag.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Flag.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
Flag.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
Flag.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Flag.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 1...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Slicing | Unordered, Open, by $this(Type) |
Mappings |
|
Flag.contained:provenance | |
Definition | Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies. |
Cardinality | 1...1 |
Type | EnglandProvenanceFlag |
Alias | inline resources, anonymous resources, contained resources, History, Event, Activity |
Comments | Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance. |
Invariants |
|
Mappings |
|
Flag.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Flag.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Flag.identifier | |
Definition | Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Requirements | Allows identification of the flag as it is known by various participating systems and in a way that remains consistent across servers. |
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
Invariants |
|
Mappings |
|
Flag.status | |
Definition | Supports basic workflow. |
Cardinality | 1...1 |
Type | code |
Binding | 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. |
Modifier | True |
Summary | True |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Invariants |
|
Mappings |
|
Flag.category | |
Definition | Allows a 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. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A general category for flags for filtering/display purposes. |
Summary | True |
Comments | The value set will often need to be adjusted based on local business rules and usage context. |
Invariants |
|
Mappings |
|
Flag.code | |
Definition | The coded value or textual component of the flag to display to the user. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Detail codes identifying specific flagged issues. |
Must Support | True |
Summary | True |
Comments | If non-coded, use CodeableConcept.text. This element should always be included in the narrative. |
Invariants |
|
Mappings |
|
Flag.subject | |
Definition | The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with. |
Cardinality | 1...1 |
Type | Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Flag.period | |
Definition | The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
Flag.encounter | |
Definition | This alert is only relevant during the encounter. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Summary | True |
Comments | If both Flag.encounter and Flag.period are valued, then Flag.period.start shall not be before Encounter.period.start and Flag.period.end shall not be after Encounter.period.end. |
Invariants |
|
Mappings |
|
Flag.author | |
Definition | The person, organization or device that created the flag. |
Cardinality | 0...1 |
Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="England-Flag-PatientFlag" /> <url value="https://fhir.nhs.uk/England/StructureDefinition/England-Flag-PatientFlag" /> <version value="0.2.0" /> <name value="EnglandFlagPatientFlag" /> <title value="England Flag Patient Flag" /> <status value="draft" /> <date value="2024-06-18" /> <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="Record whether a Patient Flags exists" /> <purpose value="This profile is made available to Record whether a Patient Flags exists ." /> <copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \&quot;License\&quot;); 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 \&quot;AS IS\&quot; 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." /> <fhirVersion value="4.0.1" /> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <mapping> <identity value="w5" /> <uri value="http://hl7.org/fhir/fivews" /> <name value="FiveWs Pattern Mapping" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Flag" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Flag" /> <derivation value="constraint" /> <differential> <element id="Flag.contained"> <path value="Flag.contained" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> </element> <element id="Flag.contained:provenance"> <path value="Flag.contained" /> <sliceName value="provenance" /> <min value="1" /> <max value="1" /> <type> <code value="Provenance" /> <profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Provenance-Flag" /> </type> </element> <element id="Flag.code"> <path value="Flag.code" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "England-Flag-PatientFlag", "url": "https://fhir.nhs.uk/England/StructureDefinition/England-Flag-PatientFlag", "version": "0.2.0", "name": "EnglandFlagPatientFlag", "title": "England Flag Patient Flag", "status": "draft", "date": "2024-06-18", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "Record whether a Patient Flags exists", "purpose": "This profile is made available to Record whether a Patient Flags exists .", "copyright": "Copyright © 2023+ 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.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" } ], "kind": "resource", "abstract": false, "type": "Flag", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Flag", "derivation": "constraint", "differential": { "element": [ { "id": "Flag.contained", "path": "Flag.contained", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "open" }, "min": 1 }, { "id": "Flag.contained:provenance", "path": "Flag.contained", "sliceName": "provenance", "min": 1, "max": "1", "type": [ { "code": "Provenance", "profile": [ "https://fhir.nhs.uk/England/StructureDefinition/England-Provenance-Flag" ] } ] }, { "id": "Flag.code", "path": "Flag.code", "mustSupport": true } ] } }
Feedback
Click here to:Report issue for England-Flag-PatientFlag, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
StructureDefinition England-Provenance-Flag
Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.nhs.uk/England/StructureDefinition/England-Provenance-Flag | draft | 0.1.0 | 2024-02-14 | Record details of the practitioner recording or removing an individual Flag. |
Profile_Purpose |
---|
This profile is made available to Record details of the practitioner recording or removing an individual Flag . |
Detailed Descriptions
Provenance | |
Definition | Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies. |
Cardinality | 0...* |
Alias | History, Event, Activity |
Comments | Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance. |
Invariants |
|
Mappings |
|
Provenance.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Provenance.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Provenance.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
Provenance.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
Provenance.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Provenance.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Provenance.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Provenance.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Provenance.target | |
Definition | The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity. |
Cardinality | 1...* |
Type | Reference(Resource) |
Summary | True |
Comments | Target references are usually version specific, but might not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource might not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion. |
Invariants |
|
Mappings |
|
Provenance.occurred[x] | |
Definition | The period during which the activity occurred. |
Cardinality | 0...1 |
Type | Period |
Comments | The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time. |
Invariants |
|
Mappings |
|
Provenance.recorded | |
Definition | The instant of time at which the activity was recorded. |
Cardinality | 1...1 |
Type | instant |
Summary | True |
Comments | This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource. |
Invariants |
|
Mappings |
|
Provenance.policy | |
Definition | Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc. |
Cardinality | 0...* |
Type | uri |
Comments | For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element. |
Invariants |
|
Mappings |
|
Provenance.location | |
Definition | Where the activity occurred, if relevant. |
Cardinality | 0...1 |
Type | Reference(Location) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Provenance.reason | |
Definition | The reason that the activity was taking place. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The reason the activity took place. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Provenance.activity | |
Definition | An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The activity that took place. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Provenance.agent | |
Definition | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. |
Cardinality | 1...* |
Type | BackboneElement |
Requirements | An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility. |
Comments | Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa. |
Invariants |
|
Mappings |
|
Provenance.agent.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Provenance.agent.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Provenance.agent.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Provenance.agent.type | |
Definition | The participation the agent had with respect to the activity. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The type of participation that a provenance agent played with respect to the activity. |
Summary | True |
Comments | For example: author, performer, enterer, attester, etc. |
Invariants |
|
Mappings |
|
Provenance.agent.role | |
Definition | The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The role that a provenance agent played with respect to the activity. |
Comments | For example: doctor, nurse, clerk, etc. |
Invariants |
|
Mappings |
|
Provenance.agent.who | |
Definition | The individual, device or organization that participated in the event. |
Cardinality | 1...1 |
Type | Reference(Practitioner) |
Summary | True |
Comments | whoIdentity should be used when the agent is not a Resource type. |
Invariants |
|
Mappings |
|
Provenance.agent.onBehalfOf | |
Definition | The individual, device, or organization for whom the change was made. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Comments | onBehalfOfIdentity should be used when the agent is not a Resource type. |
Invariants |
|
Mappings |
|
Provenance.entity | |
Definition | An entity used in this activity. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Provenance.entity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Provenance.entity.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Provenance.entity.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Provenance.entity.role | |
Definition | How the entity was used during the activity. |
Cardinality | 1...1 |
Type | code |
Binding | How an entity was used in an activity. |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Provenance.entity.what | |
Definition | Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative. |
Cardinality | 1...1 |
Type | Reference(Resource) |
Summary | True |
Comments | whatIdentity should be used for entities that are not a Resource type. |
Invariants |
|
Mappings |
|
Provenance.entity.agent | |
Definition | The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity. |
Cardinality | 0...* |
Type | see (agent) |
Comments | A usecase where one Provenance.entity.agent is used where the Entity that was used in the creation/updating of the Target, is not in the context of the same custodianship as the Target, and thus the meaning of Provenance.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 v2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the Provenance of that Entity's use in the context of this Provenance activity. |
Mappings |
|
Provenance.signature | |
Definition | A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated. |
Cardinality | 0...* |
Type | Signature |
Comments | The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form. |
Invariants |
|
Mappings |
|
Table View
Provenance | .. | |
Provenance.agent | .. | |
Provenance.agent.who | Reference(Practitioner) | .. |
Provenance.agent.onBehalfOf | Reference(Organization) | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="England-Provenance-Flag" /> <url value="https://fhir.nhs.uk/England/StructureDefinition/England-Provenance-Flag" /> <version value="0.1.0" /> <name value="EnglandProvenanceFlag" /> <title value="England Provenance Flag" /> <status value="draft" /> <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="Record details of the practitioner recording or removing an individual Flag." /> <purpose value="This profile is made available to Record details of the practitioner recording or removing an individual Flag ." /> <copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \&quot;License\&quot;); 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 \&quot;AS IS\&quot; 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." /> <fhirVersion value="4.0.1" /> <mapping> <identity value="workflow" /> <uri value="http://hl7.org/fhir/workflow" /> <name value="Workflow Pattern" /> </mapping> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <mapping> <identity value="w3c.prov" /> <uri value="http://www.w3.org/ns/prov" /> <name value="W3C PROV" /> </mapping> <mapping> <identity value="w5" /> <uri value="http://hl7.org/fhir/fivews" /> <name value="FiveWs Pattern Mapping" /> </mapping> <mapping> <identity value="fhirauditevent" /> <uri value="http://hl7.org/fhir/auditevent" /> <name value="FHIR AuditEvent Mapping" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Provenance" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Provenance" /> <derivation value="constraint" /> <differential> <element id="Provenance.agent.who"> <path value="Provenance.agent.who" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" /> </type> </element> <element id="Provenance.agent.onBehalfOf"> <path value="Provenance.agent.onBehalfOf" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" /> </type> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "England-Provenance-Flag", "url": "https://fhir.nhs.uk/England/StructureDefinition/England-Provenance-Flag", "version": "0.1.0", "name": "EnglandProvenanceFlag", "title": "England Provenance Flag", "status": "draft", "date": "2024-02-14", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "Record details of the practitioner recording or removing an individual Flag.", "purpose": "This profile is made available to Record details of the practitioner recording or removing an individual Flag .", "copyright": "Copyright © 2023+ 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.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "w3c.prov", "uri": "http://www.w3.org/ns/prov", "name": "W3C PROV" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" }, { "identity": "fhirauditevent", "uri": "http://hl7.org/fhir/auditevent", "name": "FHIR AuditEvent Mapping" } ], "kind": "resource", "abstract": false, "type": "Provenance", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Provenance", "derivation": "constraint", "differential": { "element": [ { "id": "Provenance.agent.who", "path": "Provenance.agent.who", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner" ] } ] }, { "id": "Provenance.agent.onBehalfOf", "path": "Provenance.agent.onBehalfOf", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] } ] } }
Feedback
Click here to:Report issue for England-Provenance-Flag, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Examples
Some Examples where Provenance resource is been usedAddRARecordTransaction-Bundle-Example
UpdateRARecordTransaction-Bundle-Example
AddFGMRecordTransaction-Bundle-Example