SIL HIE Implementation Guide
0.1.0 - sil-hie-active
SIL HIE Implementation Guide, published by Kathurima Kimathi. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/hie-fhir-ig-profile/ and changes regularly. See the Directory of published versions
| Official URL: https://nshr.dha.go.ke/fhir/StructureDefinition/hie-condition | Version: 0.1.0 | |||
| Active as of 2025-11-25 | Computable Name: HIECondition | |||
R4B Condition constrained for HIE capture and exchange.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Condition | Detailed information about conditions, problems or diagnoses Constraints: con-3, con-4, con-5 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | External Ids for this condition |
![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() |
Σ | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) |
![]() ![]() |
?!SΣC | 1..1 | HIECodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required) |
![]() ![]() |
?!SΣC | 1..1 | HIECodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required) |
![]() ![]() |
S | 1..* | HIECodeableConcept | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (required) |
![]() ![]() |
S | 1..1 | HIECodeableConcept | Subjective severity of condition Binding: HIE Condition Severity (required) |
![]() ![]() |
SΣ | 1..1 | HIECodeableConcept | Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis. |
![]() ![]() |
Σ | 0..* | HIECodeableConcept | Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts |
![]() ![]() |
SΣ | 1..1 | HIEReference(HIE Patient) | Who has the condition? |
![]() ![]() |
Σ | 1..1 | HIEReference(HIE Encounter) | Encounter created as part of |
![]() ![]() |
SΣ | 1..1 | dateTime | Date record was first recorded |
![]() ![]() |
Σ | 0..1 | HIEReference(HIE Practitioner | PractitionerRole | HIE Patient) | Who recorded the condition |
![]() ![]() |
Σ | 1..1 | HIEReference(Patient | HIE Practitioner | PractitionerRole | RelatedPerson) | Person who asserts this condition |
![]() ![]() |
0..* | HIEAnnotation | Additional information about the Condition | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Condition.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Condition.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Condition.clinicalStatus | Base | required | Condition Clinical Status Codes | 📦4.3.0 | FHIR Std. |
| Condition.verificationStatus | Base | required | ConditionVerificationStatus | 📦4.3.0 | FHIR Std. |
| Condition.category | Base | required | Condition Category Codes | 📦4.3.0 | FHIR Std. |
| Condition.severity | Base | required | HIE Condition Severity | 📦0.1.0 | This IG |
| Condition.code | Base | example | Condition/Problem/Diagnosis Codes | 📍4.3.0 | FHIR Std. |
| Condition.bodySite | Base | example | SNOMED CT Body Structures | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| con-3 | best practice | Condition | Condition.clinicalStatus SHOULD be present if verificationStatus is not entered-in-error and category is problem-list-item |
verificationStatus.empty().not() and verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').exists().not() and category.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-category' and code='problem-list-item').exists() implies clinicalStatus.empty().not()
|
| 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.exists() and ('#'+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(uri) = '#').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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Condition | Detailed information about conditions, problems or diagnoses | |
![]() ![]() |
S | 1..* | Identifier | External Ids for this condition |
![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() |
1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() |
S | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) |
![]() ![]() |
S | 1..1 | HIECodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required) |
![]() ![]() |
S | 1..1 | HIECodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required) |
![]() ![]() |
S | 1..* | HIECodeableConcept | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (required) |
![]() ![]() |
S | 1..1 | HIECodeableConcept | Subjective severity of condition Binding: HIE Condition Severity (required) |
![]() ![]() |
S | 1..1 | HIECodeableConcept | Identification of the condition, problem or diagnosis |
![]() ![]() |
0..* | HIECodeableConcept | Anatomical location, if relevant | |
![]() ![]() |
S | 1..1 | HIEReference(HIE Patient) | Who has the condition? |
![]() ![]() |
1..1 | HIEReference(HIE Encounter) | Encounter created as part of | |
![]() ![]() |
S | 1..1 | dateTime | Date record was first recorded |
![]() ![]() |
0..1 | HIEReference(HIE Practitioner | PractitionerRole | HIE Patient) | Who recorded the condition | |
![]() ![]() |
1..1 | HIEReference(Patient | HIE Practitioner | PractitionerRole | RelatedPerson) | Person who asserts this condition | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Simple summary (disease specific) | |
![]() ![]() ![]() |
0..* | HIEReference(Observation | DiagnosticReport) | Formal record of assessment | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Kind of staging | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | HIECodeableConcept | Manifestation/symptom | |
![]() ![]() ![]() |
0..* | HIEReference(Resource) | Supporting information found elsewhere | |
![]() ![]() |
0..* | HIEAnnotation | Additional information about the Condition | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Condition.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Condition.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Condition.clinicalStatus | Base | required | Condition Clinical Status Codes | 📦4.3.0 | FHIR Std. |
| Condition.verificationStatus | Base | required | ConditionVerificationStatus | 📦4.3.0 | FHIR Std. |
| Condition.category | Base | required | Condition Category Codes | 📦4.3.0 | FHIR Std. |
| Condition.severity | Base | required | HIE Condition Severity | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Condition | Detailed information about conditions, problems or diagnoses Constraints: con-3, con-4, con-5 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | External Ids for this condition | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!SΣC | 1..1 | HIECodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required) | ||||
![]() ![]() |
?!SΣC | 1..1 | HIECodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required) | ||||
![]() ![]() |
S | 1..* | HIECodeableConcept | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (required) | ||||
![]() ![]() |
S | 1..1 | HIECodeableConcept | Subjective severity of condition Binding: HIE Condition Severity (required) | ||||
![]() ![]() |
SΣ | 1..1 | HIECodeableConcept | Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis. | ||||
![]() ![]() |
Σ | 0..* | HIECodeableConcept | Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
![]() ![]() |
SΣ | 1..1 | HIEReference(HIE Patient) | Who has the condition? | ||||
![]() ![]() |
Σ | 1..1 | HIEReference(HIE Encounter) | Encounter created as part of | ||||
![]() ![]() |
Σ | 0..1 | Estimated or actual date, date-time, or age | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() |
C | 0..1 | When in resolution/remission | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() |
SΣ | 1..1 | dateTime | Date record was first recorded | ||||
![]() ![]() |
Σ | 0..1 | HIEReference(HIE Practitioner | PractitionerRole | HIE Patient) | Who recorded the condition | ||||
![]() ![]() |
Σ | 1..1 | HIEReference(Patient | HIE Practitioner | PractitionerRole | RelatedPerson) | Person who asserts this condition | ||||
![]() ![]() |
C | 0..* | BackboneElement | Stage/grade, usually assessed formally Constraints: con-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Simple summary (disease specific) Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages). | ||||
![]() ![]() ![]() |
C | 0..* | HIEReference(Observation | DiagnosticReport) | Formal record of assessment | ||||
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Kind of staging Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological). | |||||
![]() ![]() |
C | 0..* | BackboneElement | Supporting evidence Constraints: con-2 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
ΣC | 0..* | HIECodeableConcept | Manifestation/symptom Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition. | ||||
![]() ![]() ![]() |
ΣC | 0..* | HIEReference(Resource) | Supporting information found elsewhere | ||||
![]() ![]() |
0..* | HIEAnnotation | Additional information about the Condition | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Condition.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Condition.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Condition.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Condition.clinicalStatus | Base | required | Condition Clinical Status Codes | 📦4.3.0 | FHIR Std. |
| Condition.verificationStatus | Base | required | ConditionVerificationStatus | 📦4.3.0 | FHIR Std. |
| Condition.category | Base | required | Condition Category Codes | 📦4.3.0 | FHIR Std. |
| Condition.severity | Base | required | HIE Condition Severity | 📦0.1.0 | This IG |
| Condition.code | Base | example | Condition/Problem/Diagnosis Codes | 📍4.3.0 | FHIR Std. |
| Condition.bodySite | Base | example | SNOMED CT Body Structures | 📍4.3.0 | FHIR Std. |
| Condition.stage.summary | Base | example | Condition Stage | 📍4.3.0 | FHIR Std. |
| Condition.stage.type | Base | example | Condition Stage Type | 📍4.3.0 | FHIR Std. |
| Condition.evidence.code | Base | example | Manifestation and Symptom Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 SHOULD be present if verificationStatus is not entered-in-error and category is problem-list-item |
verificationStatus.empty().not() and verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').exists().not() and category.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-category' and code='problem-list-item').exists() implies clinicalStatus.empty().not()
|
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | Condition.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| 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: 13 elements
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Condition | Detailed information about conditions, problems or diagnoses Constraints: con-3, con-4, con-5 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | External Ids for this condition |
![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() |
Σ | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) |
![]() ![]() |
?!SΣC | 1..1 | HIECodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required) |
![]() ![]() |
?!SΣC | 1..1 | HIECodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required) |
![]() ![]() |
S | 1..* | HIECodeableConcept | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (required) |
![]() ![]() |
S | 1..1 | HIECodeableConcept | Subjective severity of condition Binding: HIE Condition Severity (required) |
![]() ![]() |
SΣ | 1..1 | HIECodeableConcept | Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis. |
![]() ![]() |
Σ | 0..* | HIECodeableConcept | Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts |
![]() ![]() |
SΣ | 1..1 | HIEReference(HIE Patient) | Who has the condition? |
![]() ![]() |
Σ | 1..1 | HIEReference(HIE Encounter) | Encounter created as part of |
![]() ![]() |
SΣ | 1..1 | dateTime | Date record was first recorded |
![]() ![]() |
Σ | 0..1 | HIEReference(HIE Practitioner | PractitionerRole | HIE Patient) | Who recorded the condition |
![]() ![]() |
Σ | 1..1 | HIEReference(Patient | HIE Practitioner | PractitionerRole | RelatedPerson) | Person who asserts this condition |
![]() ![]() |
0..* | HIEAnnotation | Additional information about the Condition | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Condition.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Condition.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Condition.clinicalStatus | Base | required | Condition Clinical Status Codes | 📦4.3.0 | FHIR Std. |
| Condition.verificationStatus | Base | required | ConditionVerificationStatus | 📦4.3.0 | FHIR Std. |
| Condition.category | Base | required | Condition Category Codes | 📦4.3.0 | FHIR Std. |
| Condition.severity | Base | required | HIE Condition Severity | 📦0.1.0 | This IG |
| Condition.code | Base | example | Condition/Problem/Diagnosis Codes | 📍4.3.0 | FHIR Std. |
| Condition.bodySite | Base | example | SNOMED CT Body Structures | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| con-3 | best practice | Condition | Condition.clinicalStatus SHOULD be present if verificationStatus is not entered-in-error and category is problem-list-item |
verificationStatus.empty().not() and verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').exists().not() and category.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-category' and code='problem-list-item').exists() implies clinicalStatus.empty().not()
|
| 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.exists() and ('#'+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(uri) = '#').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()
|
Differential View
This structure is derived from Condition
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Condition | Detailed information about conditions, problems or diagnoses | |
![]() ![]() |
S | 1..* | Identifier | External Ids for this condition |
![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() |
1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() |
S | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) |
![]() ![]() |
S | 1..1 | HIECodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required) |
![]() ![]() |
S | 1..1 | HIECodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required) |
![]() ![]() |
S | 1..* | HIECodeableConcept | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (required) |
![]() ![]() |
S | 1..1 | HIECodeableConcept | Subjective severity of condition Binding: HIE Condition Severity (required) |
![]() ![]() |
S | 1..1 | HIECodeableConcept | Identification of the condition, problem or diagnosis |
![]() ![]() |
0..* | HIECodeableConcept | Anatomical location, if relevant | |
![]() ![]() |
S | 1..1 | HIEReference(HIE Patient) | Who has the condition? |
![]() ![]() |
1..1 | HIEReference(HIE Encounter) | Encounter created as part of | |
![]() ![]() |
S | 1..1 | dateTime | Date record was first recorded |
![]() ![]() |
0..1 | HIEReference(HIE Practitioner | PractitionerRole | HIE Patient) | Who recorded the condition | |
![]() ![]() |
1..1 | HIEReference(Patient | HIE Practitioner | PractitionerRole | RelatedPerson) | Person who asserts this condition | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Simple summary (disease specific) | |
![]() ![]() ![]() |
0..* | HIEReference(Observation | DiagnosticReport) | Formal record of assessment | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Kind of staging | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | HIECodeableConcept | Manifestation/symptom | |
![]() ![]() ![]() |
0..* | HIEReference(Resource) | Supporting information found elsewhere | |
![]() ![]() |
0..* | HIEAnnotation | Additional information about the Condition | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Condition.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Condition.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Condition.clinicalStatus | Base | required | Condition Clinical Status Codes | 📦4.3.0 | FHIR Std. |
| Condition.verificationStatus | Base | required | ConditionVerificationStatus | 📦4.3.0 | FHIR Std. |
| Condition.category | Base | required | Condition Category Codes | 📦4.3.0 | FHIR Std. |
| Condition.severity | Base | required | HIE Condition Severity | 📦0.1.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Condition | Detailed information about conditions, problems or diagnoses Constraints: con-3, con-4, con-5 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | External Ids for this condition | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!SΣC | 1..1 | HIECodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required) | ||||
![]() ![]() |
?!SΣC | 1..1 | HIECodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required) | ||||
![]() ![]() |
S | 1..* | HIECodeableConcept | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (required) | ||||
![]() ![]() |
S | 1..1 | HIECodeableConcept | Subjective severity of condition Binding: HIE Condition Severity (required) | ||||
![]() ![]() |
SΣ | 1..1 | HIECodeableConcept | Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis. | ||||
![]() ![]() |
Σ | 0..* | HIECodeableConcept | Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
![]() ![]() |
SΣ | 1..1 | HIEReference(HIE Patient) | Who has the condition? | ||||
![]() ![]() |
Σ | 1..1 | HIEReference(HIE Encounter) | Encounter created as part of | ||||
![]() ![]() |
Σ | 0..1 | Estimated or actual date, date-time, or age | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() |
C | 0..1 | When in resolution/remission | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() |
SΣ | 1..1 | dateTime | Date record was first recorded | ||||
![]() ![]() |
Σ | 0..1 | HIEReference(HIE Practitioner | PractitionerRole | HIE Patient) | Who recorded the condition | ||||
![]() ![]() |
Σ | 1..1 | HIEReference(Patient | HIE Practitioner | PractitionerRole | RelatedPerson) | Person who asserts this condition | ||||
![]() ![]() |
C | 0..* | BackboneElement | Stage/grade, usually assessed formally Constraints: con-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Simple summary (disease specific) Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages). | ||||
![]() ![]() ![]() |
C | 0..* | HIEReference(Observation | DiagnosticReport) | Formal record of assessment | ||||
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Kind of staging Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological). | |||||
![]() ![]() |
C | 0..* | BackboneElement | Supporting evidence Constraints: con-2 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
ΣC | 0..* | HIECodeableConcept | Manifestation/symptom Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition. | ||||
![]() ![]() ![]() |
ΣC | 0..* | HIEReference(Resource) | Supporting information found elsewhere | ||||
![]() ![]() |
0..* | HIEAnnotation | Additional information about the Condition | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Condition.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Condition.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Condition.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Condition.clinicalStatus | Base | required | Condition Clinical Status Codes | 📦4.3.0 | FHIR Std. |
| Condition.verificationStatus | Base | required | ConditionVerificationStatus | 📦4.3.0 | FHIR Std. |
| Condition.category | Base | required | Condition Category Codes | 📦4.3.0 | FHIR Std. |
| Condition.severity | Base | required | HIE Condition Severity | 📦0.1.0 | This IG |
| Condition.code | Base | example | Condition/Problem/Diagnosis Codes | 📍4.3.0 | FHIR Std. |
| Condition.bodySite | Base | example | SNOMED CT Body Structures | 📍4.3.0 | FHIR Std. |
| Condition.stage.summary | Base | example | Condition Stage | 📍4.3.0 | FHIR Std. |
| Condition.stage.type | Base | example | Condition Stage Type | 📍4.3.0 | FHIR Std. |
| Condition.evidence.code | Base | example | Manifestation and Symptom Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 SHOULD be present if verificationStatus is not entered-in-error and category is problem-list-item |
verificationStatus.empty().not() and verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').exists().not() and category.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-category' and code='problem-list-item').exists() implies clinicalStatus.empty().not()
|
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | Condition.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| 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: 13 elements
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron