Zambia Immunizations FHIR Implementation Guide
1.0.1 - ci-build
Zambia Immunizations FHIR Implementation Guide, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/Zambia-Immunizations/ and changes regularly. See the Directory of published versions
Official URL: http://moh.gov.zm/fhir/immunizations/StructureDefinition/underlying-condition | Version: 1.0.1 | |||
Active as of 2024-09-30 | Computable Name: UnderlyingCondition |
Represents underlying conditions for the patient.
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 | Condition | |||
category | 1..1 | CodeableConcept | problem-list-item | encounter-diagnosis | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/condition-category | |
code | 0..1 | code | Symbol in syntax defined by the system Required Pattern: problem-list-item | |
code | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Underlying Conditions (required) | |
text | S | 0..1 | string | Plain text representation of the concept |
subject | 1..1 | Reference(Patient - COVAX Immunization Patient) | Who has the condition? | |
encounter | 1..1 | Reference(Encounter - Target Facility Encounter (COVAX)) | The Encounter during which this Condition was created | |
recordedDate | 1..1 | dateTime | Date condition was first recorded | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Condition.code | required | VSUnderlyingConditionhttp://moh.gov.zm/fhir/immunizations/ValueSet/vs-underlying-condition from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | C | 0..* | Condition | Detailed information about conditions, problems or diagnoses con-2: If category is problems list item, the clinicalStatus should not be unknown con-3: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission. |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
clinicalStatus | ?!ΣC | 1..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved | unknown Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. |
verificationStatus | ?!Σ | 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. |
category | C | 1..1 | CodeableConcept | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (preferred): A category assigned to the condition. |
code | Σ | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Underlying Conditions (required) |
text | SΣ | 0..1 | string | Plain text representation of the concept |
subject | Σ | 1..1 | Reference(Patient - COVAX Immunization Patient) | Who has the condition? |
encounter | Σ | 1..1 | Reference(Encounter - Target Facility Encounter (COVAX)) | The Encounter during which this Condition was created |
recordedDate | Σ | 1..1 | dateTime | Date condition was first recorded |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical|5.0.0 from the FHIR Standard | |
Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status|5.0.0 from the FHIR Standard | |
Condition.category | preferred | ConditionCategoryCodeshttp://hl7.org/fhir/ValueSet/condition-category from the FHIR Standard | |
Condition.code | required | VSUnderlyingConditionhttp://moh.gov.zm/fhir/immunizations/ValueSet/vs-underlying-condition from this IG |
Id | Grade | Path(s) | Details | Requirements |
con-2 | warning | Condition | If category is problems list item, the clinicalStatus should not be unknown : category.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-category' and code='problem-list-item').exists() implies clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and code='unknown').exists().not() | |
con-3 | error | Condition | If condition is abated, then clinicalStatus must be either inactive, resolved, or remission. : abatement.exists() implies (clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='inactive' or code='resolved' or code='remission')).exists()) | |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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-2: If category is problems list item, the clinicalStatus should not be unknown con-3: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission. | ||||
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: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Ids for this condition | ||||
clinicalStatus | ?!ΣC | 1..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved | unknown Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. | ||||
verificationStatus | ?!Σ | 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. | ||||
category | C | 1..1 | CodeableConcept | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (preferred): A category assigned to the condition. | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/condition-category | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: problem-list-item | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
severity | 0..1 | CodeableConcept | Subjective severity of condition Binding: ConditionDiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician. | |||||
code | Σ | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Underlying Conditions (required) | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
bodySite | Σ | 0..* | CodeableConcept | Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
subject | Σ | 1..1 | Reference(Patient - COVAX Immunization Patient) | Who has the condition? | ||||
encounter | Σ | 1..1 | Reference(Encounter - Target Facility Encounter (COVAX)) | The Encounter during which this Condition was created | ||||
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 | Σ | 1..1 | dateTime | Date condition was first recorded | ||||
participant | Σ | 0..* | BackboneElement | Who or what participated in the activities related to the condition and how they were involved | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | Σ | 0..1 | CodeableConcept | Type of involvement Binding: ParticipationRoleType (extensible) | ||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization | CareTeam) | Who or what participated in the activities related to the 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 | Σ | 0..* | CodeableReference(Resource) | Supporting evidence for the verification status Binding: SNOMEDCTClinicalFindings (example) | ||||
note | 0..* | Annotation | Additional information about the Condition | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Condition.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical|5.0.0 from the FHIR Standard | |
Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status|5.0.0 from the FHIR Standard | |
Condition.category | preferred | ConditionCategoryCodeshttp://hl7.org/fhir/ValueSet/condition-category from the FHIR Standard | |
Condition.severity | preferred | ConditionDiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard | |
Condition.code | required | VSUnderlyingConditionhttp://moh.gov.zm/fhir/immunizations/ValueSet/vs-underlying-condition from this IG | |
Condition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | |
Condition.participant.function | extensible | ParticipationRoleTypehttp://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard | |
Condition.stage.summary | example | ConditionStagehttp://hl7.org/fhir/ValueSet/condition-stage from the FHIR Standard | |
Condition.stage.type | example | ConditionStageTypehttp://hl7.org/fhir/ValueSet/condition-stage-type from the FHIR Standard | |
Condition.evidence | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from 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 | warning | Condition | If category is problems list item, the clinicalStatus should not be unknown : category.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-category' and code='problem-list-item').exists() implies clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and code='unknown').exists().not() | |
con-3 | error | Condition | If condition is abated, then clinicalStatus must be either inactive, resolved, or remission. : abatement.exists() implies (clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='inactive' or code='resolved' or code='remission')).exists()) | |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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
Differential View
This structure is derived from Condition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | Condition | |||
category | 1..1 | CodeableConcept | problem-list-item | encounter-diagnosis | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/condition-category | |
code | 0..1 | code | Symbol in syntax defined by the system Required Pattern: problem-list-item | |
code | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Underlying Conditions (required) | |
text | S | 0..1 | string | Plain text representation of the concept |
subject | 1..1 | Reference(Patient - COVAX Immunization Patient) | Who has the condition? | |
encounter | 1..1 | Reference(Encounter - Target Facility Encounter (COVAX)) | The Encounter during which this Condition was created | |
recordedDate | 1..1 | dateTime | Date condition was first recorded | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Condition.code | required | VSUnderlyingConditionhttp://moh.gov.zm/fhir/immunizations/ValueSet/vs-underlying-condition from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | C | 0..* | Condition | Detailed information about conditions, problems or diagnoses con-2: If category is problems list item, the clinicalStatus should not be unknown con-3: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission. |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
clinicalStatus | ?!ΣC | 1..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved | unknown Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. |
verificationStatus | ?!Σ | 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. |
category | C | 1..1 | CodeableConcept | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (preferred): A category assigned to the condition. |
code | Σ | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Underlying Conditions (required) |
text | SΣ | 0..1 | string | Plain text representation of the concept |
subject | Σ | 1..1 | Reference(Patient - COVAX Immunization Patient) | Who has the condition? |
encounter | Σ | 1..1 | Reference(Encounter - Target Facility Encounter (COVAX)) | The Encounter during which this Condition was created |
recordedDate | Σ | 1..1 | dateTime | Date condition was first recorded |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical|5.0.0 from the FHIR Standard | |
Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status|5.0.0 from the FHIR Standard | |
Condition.category | preferred | ConditionCategoryCodeshttp://hl7.org/fhir/ValueSet/condition-category from the FHIR Standard | |
Condition.code | required | VSUnderlyingConditionhttp://moh.gov.zm/fhir/immunizations/ValueSet/vs-underlying-condition from this IG |
Id | Grade | Path(s) | Details | Requirements |
con-2 | warning | Condition | If category is problems list item, the clinicalStatus should not be unknown : category.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-category' and code='problem-list-item').exists() implies clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and code='unknown').exists().not() | |
con-3 | error | Condition | If condition is abated, then clinicalStatus must be either inactive, resolved, or remission. : abatement.exists() implies (clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='inactive' or code='resolved' or code='remission')).exists()) | |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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-2: If category is problems list item, the clinicalStatus should not be unknown con-3: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission. | ||||
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: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Ids for this condition | ||||
clinicalStatus | ?!ΣC | 1..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved | unknown Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. | ||||
verificationStatus | ?!Σ | 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. | ||||
category | C | 1..1 | CodeableConcept | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (preferred): A category assigned to the condition. | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/condition-category | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: problem-list-item | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
severity | 0..1 | CodeableConcept | Subjective severity of condition Binding: ConditionDiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician. | |||||
code | Σ | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Underlying Conditions (required) | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
bodySite | Σ | 0..* | CodeableConcept | Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
subject | Σ | 1..1 | Reference(Patient - COVAX Immunization Patient) | Who has the condition? | ||||
encounter | Σ | 1..1 | Reference(Encounter - Target Facility Encounter (COVAX)) | The Encounter during which this Condition was created | ||||
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 | Σ | 1..1 | dateTime | Date condition was first recorded | ||||
participant | Σ | 0..* | BackboneElement | Who or what participated in the activities related to the condition and how they were involved | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | Σ | 0..1 | CodeableConcept | Type of involvement Binding: ParticipationRoleType (extensible) | ||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization | CareTeam) | Who or what participated in the activities related to the 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 | Σ | 0..* | CodeableReference(Resource) | Supporting evidence for the verification status Binding: SNOMEDCTClinicalFindings (example) | ||||
note | 0..* | Annotation | Additional information about the Condition | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Condition.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical|5.0.0 from the FHIR Standard | |
Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status|5.0.0 from the FHIR Standard | |
Condition.category | preferred | ConditionCategoryCodeshttp://hl7.org/fhir/ValueSet/condition-category from the FHIR Standard | |
Condition.severity | preferred | ConditionDiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard | |
Condition.code | required | VSUnderlyingConditionhttp://moh.gov.zm/fhir/immunizations/ValueSet/vs-underlying-condition from this IG | |
Condition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | |
Condition.participant.function | extensible | ParticipationRoleTypehttp://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard | |
Condition.stage.summary | example | ConditionStagehttp://hl7.org/fhir/ValueSet/condition-stage from the FHIR Standard | |
Condition.stage.type | example | ConditionStageTypehttp://hl7.org/fhir/ValueSet/condition-stage-type from the FHIR Standard | |
Condition.evidence | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from 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 | warning | Condition | If category is problems list item, the clinicalStatus should not be unknown : category.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-category' and code='problem-list-item').exists() implies clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and code='unknown').exists().not() | |
con-3 | error | Condition | If condition is abated, then clinicalStatus must be either inactive, resolved, or remission. : abatement.exists() implies (clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='inactive' or code='resolved' or code='remission')).exists()) | |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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
Other representations of profile: CSV, Excel, Schematron