XpanDH Hospital Discharge Report
0.1.0 - ci-build
150
XpanDH Hospital Discharge Report, published by XpanDH Project. 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/hl7-eu/xpandh-hdr/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.eu/fhir/ig/xpandh/hdr/StructureDefinition/condition-encounter-hdr-xpandh | Version: 0.1.0 | |||
Draft as of 2024-11-05 | Computable Name: ConditionEncounterHdrXpandh | |||
Copyright/Legal: Used by permission of the XpanDH project, all rights reserved Creative Commons License |
This profile represents the constraint applied to the Condition in the scope of Xpandh hospital discharge encounter resource. Encounter conditions implements Diagnostic summary part of the eHN data model adding two additional categories: First category distingueshes conditions present at admission and acquired during hospital stay (POA, HAC, NA - Not applicable or unknown) while second category is used to indicate impact of the condition to the treatement during hospital stay (treated, untreated).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ConditionHdrXpandh
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | ConditionHdrXpandh | |||
Slices for category | 3..* | CodeableConceptIPS | category codes Slice: Unordered, Open by value:$this | |
category:hdr-core | 1..1 | CodeableConceptIPS | encounter-diagnosis Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/condition-category | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: encounter-diagnosis | |
category:poa | 1..1 | CodeableConceptIPS | POA, HAC, NA Binding: Condition Present on Admission (POA) Value Set (required) | |
category:treated | 1..1 | CodeableConceptIPS | Treated or untreated Binding: Treatment Class Value Set (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Condition.category:poa | required | HdrPOAIndicatorXpandhVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-poa-indicator-xpandh-vs from this IG | |
Condition.category:treated | required | HdrTreatedXpandhVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-treated-xpandh-vs from this IG |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Condition | C | 0..* | ConditionHdrXpandh | Documentation of a health problem of the patient 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 | ||||||
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
clinicalStatus | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ConditionClinicalStatusCodes (required) | ||||||
verificationStatus | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ConditionVerificationStatus (required) | ||||||
Slices for category | S | 3..* | CodeableConceptIPS | category codes Slice: Unordered, Open by value:$this Binding: Problem Type - IPS (preferred)
| ||||||
category:hdr-core | S | 1..1 | CodeableConceptIPS | encounter-diagnosis Binding: Problem Type - IPS (preferred)
Required Pattern: At least the following | ||||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/condition-category | |||||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: encounter-diagnosis | |||||||
category:poa | S | 1..1 | CodeableConceptIPS | POA, HAC, NA Binding: Condition Present on Admission (POA) Value Set (required)
| ||||||
category:treated | S | 1..1 | CodeableConceptIPS | Treated or untreated Binding: Treatment Class Value Set (required)
| ||||||
severity | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Condition/DiagnosisSeverity (preferred)
| ||||||
code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Condition Value Set (required): Valueset to describe the actual problem experienced by the patient
| ||||||
bodySite | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (example) | |||||||
Slices for extension | Content/Rules for all slices | |||||||||
laterality | 0..1 | CodeableConcept | Laterality Qualifier Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | |||||||
coding | S | 0..* | CodingIPS | A reference to a code defined by a terminology system | ||||||
text | SΣ | 0..1 | string | Plain text representation of the concept | ||||||
subject | SΣ | 1..1 | Reference(Patient: HDR) | Who has the condition? | ||||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||
Slices for onset[x] | SΣ | 0..1 | Estimated or actual date, date-time, or age Slice: Unordered, Open by type:$this | |||||||
onsetDateTime | dateTime | |||||||||
onset[x]:onsetDateTime | SΣ | 0..1 | dateTime | Estimated or actual date, date-time, or age | ||||||
Slices for abatement[x] | SC | 0..1 | When in resolution/remission Slice: Unordered, Open by type:$this | |||||||
abatementDateTime | dateTime | |||||||||
abatement[x]:abatementDateTime | C | 0..1 | dateTime | When in resolution/remission | ||||||
recordedDate | SΣ | 0..1 | dateTime | Date record was first recorded | ||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical from the FHIR Standard | |
Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status from the FHIR Standard | |
Condition.category | preferred | ProblemTypeUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/problem-type-uv-ips | |
Condition.category:hdr-core | preferred | Pattern: encounter-diagnosishttp://hl7.org/fhir/uv/ips/ValueSet/problem-type-uv-ips | |
Condition.category:poa | required | HdrPOAIndicatorXpandhVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-poa-indicator-xpandh-vs from this IG | |
Condition.category:treated | required | HdrTreatedXpandhVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-treated-xpandh-vs from this IG | |
Condition.severity | preferred | Condition/DiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard | |
Condition.code | required | HdrConditionXpandhVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-condition-xpandh-vs from this IG | |
Condition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
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..* | ConditionHdrXpandh | Documentation of a health problem of the patient 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 | 1..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 | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ConditionClinicalStatusCodes (required) | ||||||
verificationStatus | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ConditionVerificationStatus (required) | ||||||
Slices for category | S | 3..* | CodeableConceptIPS | category codes Slice: Unordered, Open by value:$this Binding: Problem Type - IPS (preferred)
| ||||||
category:hdr-core | S | 1..1 | CodeableConceptIPS | encounter-diagnosis Binding: Problem Type - IPS (preferred)
Required Pattern: At least the following | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/condition-category | |||||||
version | 0..1 | string | Version of the system - if relevant | |||||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: encounter-diagnosis | |||||||
display | 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 | |||||||
category:poa | S | 1..1 | CodeableConceptIPS | POA, HAC, NA Binding: Condition Present on Admission (POA) Value Set (required)
| ||||||
category:treated | S | 1..1 | CodeableConceptIPS | Treated or untreated Binding: Treatment Class Value Set (required)
| ||||||
severity | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Condition/DiagnosisSeverity (preferred)
| ||||||
code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Condition Value Set (required): Valueset to describe the actual problem experienced by the patient
| ||||||
bodySite | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (example) | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
laterality | 0..1 | CodeableConcept | Laterality Qualifier Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | |||||||
coding | S | 0..* | CodingIPS | A reference to a code defined by a terminology system | ||||||
text | SΣ | 0..1 | string | Plain text representation of the concept | ||||||
subject | SΣ | 1..1 | Reference(Patient: HDR) | Who has the condition? | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||||
Slices for onset[x] | SΣ | 0..1 | Estimated or actual date, date-time, or age Slice: Unordered, Open by type:$this | |||||||
onsetDateTime | dateTime S | |||||||||
onsetAge | Age | |||||||||
onsetPeriod | Period | |||||||||
onsetRange | Range | |||||||||
onsetString | string | |||||||||
onset[x]:onsetDateTime | SΣ | 0..1 | dateTime S | Estimated or actual date, date-time, or age | ||||||
Slices for abatement[x] | SC | 0..1 | When in resolution/remission Slice: Unordered, Open by type:$this | |||||||
abatementDateTime | dateTime S | |||||||||
abatementAge | Age | |||||||||
abatementPeriod | Period | |||||||||
abatementRange | Range | |||||||||
abatementString | string | |||||||||
abatement[x]:abatementDateTime | C | 0..1 | dateTime | When in resolution/remission | ||||||
recordedDate | SΣ | 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 | Most recent Stage Group Binding: Cancer Stage Grading: Snomed CT (required) | ||||||
assessment | C | 0..* | Reference(Observation: Cancer Stage Group) | Formal record of assessment | ||||||
type | 0..1 | CodeableConcept | Staging system used. 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 / Code | URI | |||
Condition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical from the FHIR Standard | ||||
Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status from the FHIR Standard | ||||
Condition.category | preferred | ProblemTypeUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/problem-type-uv-ips | ||||
Condition.category:hdr-core | preferred | Pattern: encounter-diagnosishttp://hl7.org/fhir/uv/ips/ValueSet/problem-type-uv-ips | ||||
Condition.category:poa | required | HdrPOAIndicatorXpandhVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-poa-indicator-xpandh-vs from this IG | ||||
Condition.category:treated | required | HdrTreatedXpandhVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-treated-xpandh-vs from this IG | ||||
Condition.severity | preferred | Condition/DiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard | ||||
Condition.code | required | HdrConditionXpandhVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-condition-xpandh-vs from this IG | ||||
Condition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Condition.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Condition.stage.summary | required | CancerStageGradingVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/cancer-stage-grading-vs from this IG | ||||
Condition.stage.type | example | ConditionStageTypehttp://hl7.org/fhir/ValueSet/condition-stage-type from the FHIR Standard | ||||
Condition.evidence.code | example | ManifestationAndSymptomCodeshttp://hl7.org/fhir/ValueSet/manifestation-or-symptom 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 | 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 ConditionHdrXpandh
Summary
Mandatory: 3 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ConditionHdrXpandh
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | ConditionHdrXpandh | |||
Slices for category | 3..* | CodeableConceptIPS | category codes Slice: Unordered, Open by value:$this | |
category:hdr-core | 1..1 | CodeableConceptIPS | encounter-diagnosis Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/condition-category | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: encounter-diagnosis | |
category:poa | 1..1 | CodeableConceptIPS | POA, HAC, NA Binding: Condition Present on Admission (POA) Value Set (required) | |
category:treated | 1..1 | CodeableConceptIPS | Treated or untreated Binding: Treatment Class Value Set (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Condition.category:poa | required | HdrPOAIndicatorXpandhVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-poa-indicator-xpandh-vs from this IG | |
Condition.category:treated | required | HdrTreatedXpandhVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-treated-xpandh-vs from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Condition | C | 0..* | ConditionHdrXpandh | Documentation of a health problem of the patient 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 | ||||||
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
clinicalStatus | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ConditionClinicalStatusCodes (required) | ||||||
verificationStatus | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ConditionVerificationStatus (required) | ||||||
Slices for category | S | 3..* | CodeableConceptIPS | category codes Slice: Unordered, Open by value:$this Binding: Problem Type - IPS (preferred)
| ||||||
category:hdr-core | S | 1..1 | CodeableConceptIPS | encounter-diagnosis Binding: Problem Type - IPS (preferred)
Required Pattern: At least the following | ||||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/condition-category | |||||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: encounter-diagnosis | |||||||
category:poa | S | 1..1 | CodeableConceptIPS | POA, HAC, NA Binding: Condition Present on Admission (POA) Value Set (required)
| ||||||
category:treated | S | 1..1 | CodeableConceptIPS | Treated or untreated Binding: Treatment Class Value Set (required)
| ||||||
severity | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Condition/DiagnosisSeverity (preferred)
| ||||||
code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Condition Value Set (required): Valueset to describe the actual problem experienced by the patient
| ||||||
bodySite | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (example) | |||||||
Slices for extension | Content/Rules for all slices | |||||||||
laterality | 0..1 | CodeableConcept | Laterality Qualifier Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | |||||||
coding | S | 0..* | CodingIPS | A reference to a code defined by a terminology system | ||||||
text | SΣ | 0..1 | string | Plain text representation of the concept | ||||||
subject | SΣ | 1..1 | Reference(Patient: HDR) | Who has the condition? | ||||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||
Slices for onset[x] | SΣ | 0..1 | Estimated or actual date, date-time, or age Slice: Unordered, Open by type:$this | |||||||
onsetDateTime | dateTime | |||||||||
onset[x]:onsetDateTime | SΣ | 0..1 | dateTime | Estimated or actual date, date-time, or age | ||||||
Slices for abatement[x] | SC | 0..1 | When in resolution/remission Slice: Unordered, Open by type:$this | |||||||
abatementDateTime | dateTime | |||||||||
abatement[x]:abatementDateTime | C | 0..1 | dateTime | When in resolution/remission | ||||||
recordedDate | SΣ | 0..1 | dateTime | Date record was first recorded | ||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical from the FHIR Standard | |
Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status from the FHIR Standard | |
Condition.category | preferred | ProblemTypeUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/problem-type-uv-ips | |
Condition.category:hdr-core | preferred | Pattern: encounter-diagnosishttp://hl7.org/fhir/uv/ips/ValueSet/problem-type-uv-ips | |
Condition.category:poa | required | HdrPOAIndicatorXpandhVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-poa-indicator-xpandh-vs from this IG | |
Condition.category:treated | required | HdrTreatedXpandhVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-treated-xpandh-vs from this IG | |
Condition.severity | preferred | Condition/DiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard | |
Condition.code | required | HdrConditionXpandhVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-condition-xpandh-vs from this IG | |
Condition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
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..* | ConditionHdrXpandh | Documentation of a health problem of the patient 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 | 1..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 | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ConditionClinicalStatusCodes (required) | ||||||
verificationStatus | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ConditionVerificationStatus (required) | ||||||
Slices for category | S | 3..* | CodeableConceptIPS | category codes Slice: Unordered, Open by value:$this Binding: Problem Type - IPS (preferred)
| ||||||
category:hdr-core | S | 1..1 | CodeableConceptIPS | encounter-diagnosis Binding: Problem Type - IPS (preferred)
Required Pattern: At least the following | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/condition-category | |||||||
version | 0..1 | string | Version of the system - if relevant | |||||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: encounter-diagnosis | |||||||
display | 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 | |||||||
category:poa | S | 1..1 | CodeableConceptIPS | POA, HAC, NA Binding: Condition Present on Admission (POA) Value Set (required)
| ||||||
category:treated | S | 1..1 | CodeableConceptIPS | Treated or untreated Binding: Treatment Class Value Set (required)
| ||||||
severity | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Condition/DiagnosisSeverity (preferred)
| ||||||
code | S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Condition Value Set (required): Valueset to describe the actual problem experienced by the patient
| ||||||
bodySite | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (example) | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
laterality | 0..1 | CodeableConcept | Laterality Qualifier Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | |||||||
coding | S | 0..* | CodingIPS | A reference to a code defined by a terminology system | ||||||
text | SΣ | 0..1 | string | Plain text representation of the concept | ||||||
subject | SΣ | 1..1 | Reference(Patient: HDR) | Who has the condition? | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||||
Slices for onset[x] | SΣ | 0..1 | Estimated or actual date, date-time, or age Slice: Unordered, Open by type:$this | |||||||
onsetDateTime | dateTime S | |||||||||
onsetAge | Age | |||||||||
onsetPeriod | Period | |||||||||
onsetRange | Range | |||||||||
onsetString | string | |||||||||
onset[x]:onsetDateTime | SΣ | 0..1 | dateTime S | Estimated or actual date, date-time, or age | ||||||
Slices for abatement[x] | SC | 0..1 | When in resolution/remission Slice: Unordered, Open by type:$this | |||||||
abatementDateTime | dateTime S | |||||||||
abatementAge | Age | |||||||||
abatementPeriod | Period | |||||||||
abatementRange | Range | |||||||||
abatementString | string | |||||||||
abatement[x]:abatementDateTime | C | 0..1 | dateTime | When in resolution/remission | ||||||
recordedDate | SΣ | 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 | Most recent Stage Group Binding: Cancer Stage Grading: Snomed CT (required) | ||||||
assessment | C | 0..* | Reference(Observation: Cancer Stage Group) | Formal record of assessment | ||||||
type | 0..1 | CodeableConcept | Staging system used. 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 / Code | URI | |||
Condition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical from the FHIR Standard | ||||
Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status from the FHIR Standard | ||||
Condition.category | preferred | ProblemTypeUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/problem-type-uv-ips | ||||
Condition.category:hdr-core | preferred | Pattern: encounter-diagnosishttp://hl7.org/fhir/uv/ips/ValueSet/problem-type-uv-ips | ||||
Condition.category:poa | required | HdrPOAIndicatorXpandhVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-poa-indicator-xpandh-vs from this IG | ||||
Condition.category:treated | required | HdrTreatedXpandhVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-treated-xpandh-vs from this IG | ||||
Condition.severity | preferred | Condition/DiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard | ||||
Condition.code | required | HdrConditionXpandhVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-condition-xpandh-vs from this IG | ||||
Condition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Condition.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Condition.stage.summary | required | CancerStageGradingVShttp://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/cancer-stage-grading-vs from this IG | ||||
Condition.stage.type | example | ConditionStageTypehttp://hl7.org/fhir/ValueSet/condition-stage-type from the FHIR Standard | ||||
Condition.evidence.code | example | ManifestationAndSymptomCodeshttp://hl7.org/fhir/ValueSet/manifestation-or-symptom 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 | 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 ConditionHdrXpandh
Summary
Mandatory: 3 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron