Patient Flags - NHS England - Implementation Guide STU1
0.4.0 - ci-build
Patient Flags - NHS England - Implementation Guide STU1
0.4.0 - ci-build
Patient Flags - NHS England - Implementation Guide STU1 - Local Development build (v0.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.nhs.uk/England/StructureDefinition/FlagCondition | Version: 0.4.0 | |||
| Draft as of 2024-02-14 | Computable Name: FlagCondition | |||
Copyright/Legal: Copyright © 2024+ NHS England Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
||||
Record an individual condition for a flag in NHS England
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Condition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Condition |
0..* | Condition | Detailed information about conditions, problems or diagnoses | |
  Slices for contained |
1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:contained | |
   contained:provenance |
1..1 | FlagProvenance | Who, What, When for a set of resources | |
| Slices for category |
2..* | CodeableConcept | problem-list-item | encounter-diagnosis Slice: Unordered, Open by pattern:$this | |
 category:patientFlag |
S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: NHSE Patient Flag Category (required) |
| category:conditionCategory |
S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: NHSE Flag Condition Category (required) |
  code |
S | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: NHSE Flag Condition Code (extensible) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Condition.category:patientFlag | required | PatientFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/PatientFlagCategoryfrom this IG | |
| Condition.category:conditionCategory | required | FlagConditionCategoryhttps://fhir.nhs.uk/England/ValueSet/FlagConditionCategoryfrom this IG | |
| Condition.code | extensible | FlagConditionCodehttps://fhir.nhs.uk/England/ValueSet/FlagConditionCodefrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Condition |
C | 0..* | Condition | Detailed information about conditions, problems or diagnoses con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for contained |
1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:contained | |
| contained:provenance |
1..1 | FlagProvenance | Who, What, When for a set of resources | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 clinicalStatus |
?!ΣC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. |
| verificationStatus |
?!ΣC | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis. |
| Slices for category |
2..* | CodeableConcept | problem-list-item | encounter-diagnosis Slice: Unordered, Open by pattern:$this Binding: ConditionCategoryCodes (extensible): A category assigned to the condition. | |
| category:patientFlag |
S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: NHSE Patient Flag Category (required) |
| category:conditionCategory |
S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: NHSE Flag Condition Category (required) |
| code |
SΣ | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: NHSE Flag Condition Code (extensible) |
 subject |
Σ | 1..1 | Reference(Patient | Group) | Who has the condition? |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical|4.0.1from the FHIR Standard | |
| Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1from the FHIR Standard | |
| Condition.category | extensible | ConditionCategoryCodeshttp://hl7.org/fhir/ValueSet/condition-categoryfrom the FHIR Standard | |
| Condition.category:patientFlag | required | PatientFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/PatientFlagCategoryfrom this IG | |
| Condition.category:conditionCategory | required | FlagConditionCategoryhttps://fhir.nhs.uk/England/ValueSet/FlagConditionCategoryfrom this IG | |
| Condition.code | extensible | FlagConditionCodehttps://fhir.nhs.uk/England/ValueSet/FlagConditionCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| con-3 | best practice | Condition | Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty() | |
| con-4 | error | Condition | If condition is abated, then clinicalStatus must be either inactive, resolved, or remission : abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists() | |
| con-5 | error | Condition | Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty() | |
| dom-2 | error | Condition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Condition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Condition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Condition |
C | 0..* | Condition | Detailed information about conditions, problems or diagnoses con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| Slices for contained |
1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:contained | |||||
| contained:provenance |
1..1 | FlagProvenance | Who, What, When for a set of resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this condition | ||||
| clinicalStatus |
?!ΣC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. | ||||
| verificationStatus |
?!ΣC | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis. | ||||
| Slices for category |
2..* | CodeableConcept | problem-list-item | encounter-diagnosis Slice: Unordered, Open by pattern:$this Binding: ConditionCategoryCodes (extensible): A category assigned to the condition. | |||||
| category:patientFlag |
S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: NHSE Patient Flag Category (required) | ||||
| category:conditionCategory |
S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: NHSE Flag Condition Category (required) | ||||
| severity |
0..1 | CodeableConcept | Subjective severity of condition Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician. | |||||
| code |
SΣ | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: NHSE Flag Condition Code (extensible) | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who has the condition? | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
 onset[x] |
Σ | 0..1 | Estimated or actual date, date-time, or age | |||||
| onsetDateTime |
dateTime | |||||||
| onsetAge |
Age | |||||||
| onsetPeriod |
Period | |||||||
| onsetRange |
Range | |||||||
| onsetString |
string | |||||||
| abatement[x] |
C | 0..1 | When in resolution/remission | |||||
| abatementDateTime |
dateTime | |||||||
| abatementAge |
Age | |||||||
| abatementPeriod |
Period | |||||||
| abatementRange |
Range | |||||||
| abatementString |
string | |||||||
| recordedDate |
Σ | 0..1 | dateTime | Date record was first recorded | ||||
| recorder |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the condition | ||||
| asserter |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Person who asserts this condition | ||||
| stage |
C | 0..* | BackboneElement | Stage/grade, usually assessed formally con-1: Stage SHALL have summary or assessment | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| summary |
C | 0..1 | CodeableConcept | Simple summary (disease specific) Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages). | ||||
| assessment |
C | 0..* | Reference(ClinicalImpression | DiagnosticReport | Observation) | Formal record of assessment | ||||
| type |
0..1 | CodeableConcept | Kind of staging Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological). | |||||
| evidence |
C | 0..* | BackboneElement | Supporting evidence con-2: evidence SHALL have code or details | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
ΣC | 0..* | CodeableConcept | Manifestation/symptom Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition. | ||||
| detail |
ΣC | 0..* | Reference(Resource) | Supporting information found elsewhere | ||||
| note |
0..* | Annotation | Additional information about the Condition | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Condition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical|4.0.1from the FHIR Standard | ||||
| Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1from the FHIR Standard | ||||
| Condition.category | extensible | ConditionCategoryCodeshttp://hl7.org/fhir/ValueSet/condition-categoryfrom the FHIR Standard | ||||
| Condition.category:patientFlag | required | PatientFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/PatientFlagCategoryfrom this IG | ||||
| Condition.category:conditionCategory | required | FlagConditionCategoryhttps://fhir.nhs.uk/England/ValueSet/FlagConditionCategoryfrom this IG | ||||
| Condition.severity | preferred | Condition/DiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severityfrom the FHIR Standard | ||||
| Condition.code | extensible | FlagConditionCodehttps://fhir.nhs.uk/England/ValueSet/FlagConditionCodefrom this IG | ||||
| Condition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| Condition.stage.summary | example | ConditionStagehttp://hl7.org/fhir/ValueSet/condition-stagefrom the FHIR Standard | ||||
| Condition.stage.type | example | ConditionStageTypehttp://hl7.org/fhir/ValueSet/condition-stage-typefrom the FHIR Standard | ||||
| Condition.evidence.code | example | ManifestationAndSymptomCodeshttp://hl7.org/fhir/ValueSet/manifestation-or-symptomfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| con-1 | error | Condition.stage | Stage SHALL have summary or assessment : summary.exists() or assessment.exists() | |
| con-2 | error | Condition.evidence | evidence SHALL have code or details : code.exists() or detail.exists() | |
| con-3 | best practice | Condition | Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty() | |
| con-4 | error | Condition | If condition is abated, then clinicalStatus must be either inactive, resolved, or remission : abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists() | |
| con-5 | error | Condition | Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty() | |
| dom-2 | error | Condition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Condition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Condition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Condition
Summary
Mandatory: 5 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Condition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Condition |
0..* | Condition | Detailed information about conditions, problems or diagnoses | |
| Slices for contained |
1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:contained | |
| contained:provenance |
1..1 | FlagProvenance | Who, What, When for a set of resources | |
| Slices for category |
2..* | CodeableConcept | problem-list-item | encounter-diagnosis Slice: Unordered, Open by pattern:$this | |
| category:patientFlag |
S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: NHSE Patient Flag Category (required) |
| category:conditionCategory |
S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: NHSE Flag Condition Category (required) |
| code |
S | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: NHSE Flag Condition Code (extensible) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Condition.category:patientFlag | required | PatientFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/PatientFlagCategoryfrom this IG | |
| Condition.category:conditionCategory | required | FlagConditionCategoryhttps://fhir.nhs.uk/England/ValueSet/FlagConditionCategoryfrom this IG | |
| Condition.code | extensible | FlagConditionCodehttps://fhir.nhs.uk/England/ValueSet/FlagConditionCodefrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Condition |
C | 0..* | Condition | Detailed information about conditions, problems or diagnoses con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for contained |
1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:contained | |
| contained:provenance |
1..1 | FlagProvenance | Who, What, When for a set of resources | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| clinicalStatus |
?!ΣC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. |
| verificationStatus |
?!ΣC | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis. |
| Slices for category |
2..* | CodeableConcept | problem-list-item | encounter-diagnosis Slice: Unordered, Open by pattern:$this Binding: ConditionCategoryCodes (extensible): A category assigned to the condition. | |
| category:patientFlag |
S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: NHSE Patient Flag Category (required) |
| category:conditionCategory |
S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: NHSE Flag Condition Category (required) |
| code |
SΣ | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: NHSE Flag Condition Code (extensible) |
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who has the condition? |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical|4.0.1from the FHIR Standard | |
| Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1from the FHIR Standard | |
| Condition.category | extensible | ConditionCategoryCodeshttp://hl7.org/fhir/ValueSet/condition-categoryfrom the FHIR Standard | |
| Condition.category:patientFlag | required | PatientFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/PatientFlagCategoryfrom this IG | |
| Condition.category:conditionCategory | required | FlagConditionCategoryhttps://fhir.nhs.uk/England/ValueSet/FlagConditionCategoryfrom this IG | |
| Condition.code | extensible | FlagConditionCodehttps://fhir.nhs.uk/England/ValueSet/FlagConditionCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| con-3 | best practice | Condition | Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty() | |
| con-4 | error | Condition | If condition is abated, then clinicalStatus must be either inactive, resolved, or remission : abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists() | |
| con-5 | error | Condition | Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty() | |
| dom-2 | error | Condition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Condition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Condition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Condition |
C | 0..* | Condition | Detailed information about conditions, problems or diagnoses con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| Slices for contained |
1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:contained | |||||
| contained:provenance |
1..1 | FlagProvenance | Who, What, When for a set of resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this condition | ||||
| clinicalStatus |
?!ΣC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. | ||||
| verificationStatus |
?!ΣC | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis. | ||||
| Slices for category |
2..* | CodeableConcept | problem-list-item | encounter-diagnosis Slice: Unordered, Open by pattern:$this Binding: ConditionCategoryCodes (extensible): A category assigned to the condition. | |||||
| category:patientFlag |
S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: NHSE Patient Flag Category (required) | ||||
| category:conditionCategory |
S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: NHSE Flag Condition Category (required) | ||||
| severity |
0..1 | CodeableConcept | Subjective severity of condition Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician. | |||||
| code |
SΣ | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: NHSE Flag Condition Code (extensible) | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who has the condition? | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| onset[x] |
Σ | 0..1 | Estimated or actual date, date-time, or age | |||||
| onsetDateTime |
dateTime | |||||||
| onsetAge |
Age | |||||||
| onsetPeriod |
Period | |||||||
| onsetRange |
Range | |||||||
| onsetString |
string | |||||||
| abatement[x] |
C | 0..1 | When in resolution/remission | |||||
| abatementDateTime |
dateTime | |||||||
| abatementAge |
Age | |||||||
| abatementPeriod |
Period | |||||||
| abatementRange |
Range | |||||||
| abatementString |
string | |||||||
| recordedDate |
Σ | 0..1 | dateTime | Date record was first recorded | ||||
| recorder |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the condition | ||||
| asserter |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Person who asserts this condition | ||||
| stage |
C | 0..* | BackboneElement | Stage/grade, usually assessed formally con-1: Stage SHALL have summary or assessment | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| summary |
C | 0..1 | CodeableConcept | Simple summary (disease specific) Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages). | ||||
| assessment |
C | 0..* | Reference(ClinicalImpression | DiagnosticReport | Observation) | Formal record of assessment | ||||
| type |
0..1 | CodeableConcept | Kind of staging Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological). | |||||
| evidence |
C | 0..* | BackboneElement | Supporting evidence con-2: evidence SHALL have code or details | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
ΣC | 0..* | CodeableConcept | Manifestation/symptom Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition. | ||||
| detail |
ΣC | 0..* | Reference(Resource) | Supporting information found elsewhere | ||||
| note |
0..* | Annotation | Additional information about the Condition | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Condition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical|4.0.1from the FHIR Standard | ||||
| Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1from the FHIR Standard | ||||
| Condition.category | extensible | ConditionCategoryCodeshttp://hl7.org/fhir/ValueSet/condition-categoryfrom the FHIR Standard | ||||
| Condition.category:patientFlag | required | PatientFlagCategoryhttps://fhir.nhs.uk/England/ValueSet/PatientFlagCategoryfrom this IG | ||||
| Condition.category:conditionCategory | required | FlagConditionCategoryhttps://fhir.nhs.uk/England/ValueSet/FlagConditionCategoryfrom this IG | ||||
| Condition.severity | preferred | Condition/DiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severityfrom the FHIR Standard | ||||
| Condition.code | extensible | FlagConditionCodehttps://fhir.nhs.uk/England/ValueSet/FlagConditionCodefrom this IG | ||||
| Condition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| Condition.stage.summary | example | ConditionStagehttp://hl7.org/fhir/ValueSet/condition-stagefrom the FHIR Standard | ||||
| Condition.stage.type | example | ConditionStageTypehttp://hl7.org/fhir/ValueSet/condition-stage-typefrom the FHIR Standard | ||||
| Condition.evidence.code | example | ManifestationAndSymptomCodeshttp://hl7.org/fhir/ValueSet/manifestation-or-symptomfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| con-1 | error | Condition.stage | Stage SHALL have summary or assessment : summary.exists() or assessment.exists() | |
| con-2 | error | Condition.evidence | evidence SHALL have code or details : code.exists() or detail.exists() | |
| con-3 | best practice | Condition | Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty() | |
| con-4 | error | Condition | If condition is abated, then clinicalStatus must be either inactive, resolved, or remission : abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists() | |
| con-5 | error | Condition | Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty() | |
| dom-2 | error | Condition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Condition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Condition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Condition
Summary
Mandatory: 5 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © Copyright © 2024+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. NHS England. Package patient-flags.stu1#0.4.0 based on FHIR 4.0.1. Generated 2024-07-02
