Common Data Models Harmonization, published by HL7 International - Biomedical Research and Regulation Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/cdmh/ and changes regularly. See the Directory of published versions
Defining URL: | http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-condition |
Version: | 1.0.0 |
Name: | CdmhCondition |
Title: | CDMH Condition |
Status: | Draft as of 9/1/19 |
Definition: | This is the Condition Resource profile for the IG. |
Publisher: | HL7 International - Biomedical Research and Regulation Work Group |
Copyright: | Used by permission of HL7, all rights reserved Creative Commons License |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-condition
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreCondition
Summary
Mandatory: 1 element
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from USCoreCondition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | 0..* | USCoreCondition | CDMH Condition | |
code | ||||
cdmh-pcornet-condition-source | S | 0..1 | code | PCORNetConditionSource URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-condition-source Binding: PCORNet Condition Source (extensible): Condition Source Codes for PCORNet data marts |
subject | S | 1..1 | Reference(CDMH Patient) | Who has the condition? |
encounter | S | 0..1 | Reference(CDMH Encounter) | Encounter created as part of |
onsetDateTime | S | 0..1 | dateTime | Estimated or actual date, date-time, or age |
abatementDateTime | S | 0..1 | dateTime | When in resolution/remission |
recordedDate | S | 0..1 | dateTime | Date record was first recorded |
note | S | 0..1 | Annotation | Additional information about the Condition |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | I | 0..* | USCoreCondition | CDMH Condition |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | ?!SΣI | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required) |
verificationStatus | ?!SΣI | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required) |
category | SI | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis | health-concern Binding: US Core Condition Category Codes (extensible) |
severity | 0..1 | CodeableConcept | Subjective severity of condition Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician. | |
code | SΣ | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: US Core Condition Code (extensible): Valueset to describe the actual problem experienced by the patient |
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 | |
cdmh-pcornet-condition-source | S | 0..1 | code | PCORNetConditionSource URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-condition-source Binding: PCORNet Condition Source (extensible): Condition Source Codes for PCORNet data marts |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
text | Σ | 0..1 | string | Plain text representation of the concept |
bodySite | Σ | 0..* | CodeableConcept | Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
subject | SΣ | 1..1 | Reference(CDMH Patient) | Who has the condition? |
encounter | SΣ | 0..1 | Reference(CDMH Encounter) | Encounter created as part of |
Slices for onset[x] | Σ | 0..1 | dateTime | Estimated or actual date, date-time, or age Slice: Unordered, Closed by type:$this |
onset[x]:onsetDateTime | SΣ | 0..1 | dateTime | Estimated or actual date, date-time, or age |
Slices for abatement[x] | I | 0..1 | dateTime | When in resolution/remission Slice: Unordered, Closed by type:$this |
abatement[x]:abatementDateTime | SI | 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 | I | 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 | I | 0..1 | CodeableConcept | Simple summary (disease specific) Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages). |
assessment | I | 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 | I | 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 | ΣI | 0..* | CodeableConcept | Manifestation/symptom Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition. |
detail | ΣI | 0..* | Reference(Resource) | Supporting information found elsewhere |
note | S | 0..1 | Annotation | Additional information about the Condition |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | I | 0..* | USCoreCondition | CDMH Condition |
clinicalStatus | ?!ΣI | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required) |
verificationStatus | ?!ΣI | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required) |
category | I | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis | health-concern Binding: US Core Condition Category Codes (extensible) |
code | Σ | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: US Core Condition Code (extensible): Valueset to describe the actual problem experienced by the patient |
cdmh-pcornet-condition-source | 0..1 | code | PCORNetConditionSource URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-condition-source Binding: PCORNet Condition Source (extensible): Condition Source Codes for PCORNet data marts | |
subject | Σ | 1..1 | Reference(CDMH Patient) | Who has the condition? |
encounter | Σ | 0..1 | Reference(CDMH Encounter) | Encounter created as part of |
onset[x]:onsetDateTime | Σ | 0..1 | dateTime | Estimated or actual date, date-time, or age |
abatement[x]:abatementDateTime | I | 0..1 | dateTime | When in resolution/remission |
recordedDate | Σ | 0..1 | dateTime | Date record was first recorded |
note | 0..1 | Annotation | Additional information about the Condition | |
Documentation for this format |
This structure is derived from USCoreCondition
Summary
Mandatory: 1 element
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from USCoreCondition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | 0..* | USCoreCondition | CDMH Condition | |
code | ||||
cdmh-pcornet-condition-source | S | 0..1 | code | PCORNetConditionSource URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-condition-source Binding: PCORNet Condition Source (extensible): Condition Source Codes for PCORNet data marts |
subject | S | 1..1 | Reference(CDMH Patient) | Who has the condition? |
encounter | S | 0..1 | Reference(CDMH Encounter) | Encounter created as part of |
onsetDateTime | S | 0..1 | dateTime | Estimated or actual date, date-time, or age |
abatementDateTime | S | 0..1 | dateTime | When in resolution/remission |
recordedDate | S | 0..1 | dateTime | Date record was first recorded |
note | S | 0..1 | Annotation | Additional information about the Condition |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | I | 0..* | USCoreCondition | CDMH Condition |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | ?!SΣI | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required) |
verificationStatus | ?!SΣI | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required) |
category | SI | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis | health-concern Binding: US Core Condition Category Codes (extensible) |
severity | 0..1 | CodeableConcept | Subjective severity of condition Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician. | |
code | SΣ | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: US Core Condition Code (extensible): Valueset to describe the actual problem experienced by the patient |
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 | |
cdmh-pcornet-condition-source | S | 0..1 | code | PCORNetConditionSource URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-condition-source Binding: PCORNet Condition Source (extensible): Condition Source Codes for PCORNet data marts |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
text | Σ | 0..1 | string | Plain text representation of the concept |
bodySite | Σ | 0..* | CodeableConcept | Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
subject | SΣ | 1..1 | Reference(CDMH Patient) | Who has the condition? |
encounter | SΣ | 0..1 | Reference(CDMH Encounter) | Encounter created as part of |
Slices for onset[x] | Σ | 0..1 | dateTime | Estimated or actual date, date-time, or age Slice: Unordered, Closed by type:$this |
onset[x]:onsetDateTime | SΣ | 0..1 | dateTime | Estimated or actual date, date-time, or age |
Slices for abatement[x] | I | 0..1 | dateTime | When in resolution/remission Slice: Unordered, Closed by type:$this |
abatement[x]:abatementDateTime | SI | 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 | I | 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 | I | 0..1 | CodeableConcept | Simple summary (disease specific) Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages). |
assessment | I | 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 | I | 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 | ΣI | 0..* | CodeableConcept | Manifestation/symptom Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition. |
detail | ΣI | 0..* | Reference(Resource) | Supporting information found elsewhere |
note | S | 0..1 | Annotation | Additional information about the Condition |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Condition.language | preferred | CommonLanguages Max Binding: AllLanguages |
Condition.clinicalStatus | required | ConditionClinicalStatusCodes |
Condition.verificationStatus | required | ConditionVerificationStatus |
Condition.category | extensible | USCoreConditionCategoryCodes |
Condition.severity | preferred | Condition/DiagnosisSeverity |
Condition.code | extensible | USCoreConditionCode |
Condition.bodySite | example | SNOMEDCTBodyStructures |
Condition.stage.summary | example | ConditionStage |
Condition.stage.type | example | ConditionStageType |
Condition.evidence.code | example | ManifestationAndSymptomCodes |
Id | Path | Details | Requirements |
con-3 | 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 | 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 | 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 | Condition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | 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 | 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 | Condition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Condition | A resource should have narrative for robust management : text.`div`.exists() | |
us-core-1 | Condition | A code in Condition.category SHOULD be from US Core Condition Category Codes value set. : where(category.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-condition-category')).exists() | |
ele-1 | Condition.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Condition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Condition.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Condition.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Condition.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.clinicalStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.verificationStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.severity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.code.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Condition.code.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Condition.code.extension:pcornet-condition-source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Condition.code.extension:pcornet-condition-source | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Condition.code.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.code.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.bodySite | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.onset[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.onset[x]:onsetDateTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.abatement[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.abatement[x]:abatementDateTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.recordedDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.recorder | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.asserter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
con-1 | Condition.stage | Stage SHALL have summary or assessment : summary.exists() or assessment.exists() | |
ele-1 | Condition.stage | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.stage.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Condition.stage.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Condition.stage.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Condition.stage.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Condition.stage.summary | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.stage.assessment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.stage.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
con-2 | Condition.evidence | evidence SHALL have code or details : code.exists() or detail.exists() | |
ele-1 | Condition.evidence | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.evidence.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Condition.evidence.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Condition.evidence.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Condition.evidence.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Condition.evidence.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.evidence.detail | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Condition.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |