Common Data Models Harmonization
1.0.0 - STU 1 Publication

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

Resource Profile: CdmhCondition

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

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition 0..*USCoreConditionCDMH Condition
... code
.... cdmh-pcornet-condition-source S0..1codePCORNetConditionSource
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 S1..1Reference(CDMH Patient)Who has the condition?
... encounter S0..1Reference(CDMH Encounter)Encounter created as part of
... abatementDateTime S0..1dateTimeWhen in resolution/remission
... recordedDate S0..1dateTimeDate record was first recorded
... note S0..1AnnotationAdditional information about the Condition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition I0..*USCoreConditionCDMH Condition
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this condition
... clinicalStatus ?!SΣI0..1CodeableConceptactive | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required)
... verificationStatus ?!SΣI0..1CodeableConceptunconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: ConditionVerificationStatus (required)
... category SI1..*CodeableConceptproblem-list-item | encounter-diagnosis | health-concern
Binding: US Core Condition Category Codes (extensible)
... severity 0..1CodeableConceptSubjective severity of condition
Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician.

... code SΣ1..1CodeableConceptIdentification of the condition, problem or diagnosis
Binding: US Core Condition Code (extensible): Valueset to describe the actual problem experienced by the patient

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... cdmh-pcornet-condition-source S0..1codePCORNetConditionSource
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..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... bodySite Σ0..*CodeableConceptAnatomical location, if relevant
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... subject SΣ1..1Reference(CDMH Patient)Who has the condition?
... encounter SΣ0..1Reference(CDMH Encounter)Encounter created as part of
... Slices for onset[x] Σ0..1dateTimeEstimated or actual date, date-time, or age
Slice: Unordered, Closed by type:$this
.... onset[x]:onsetDateTime SΣ0..1dateTimeEstimated or actual date, date-time, or age
... Slices for abatement[x] I0..1dateTimeWhen in resolution/remission
Slice: Unordered, Closed by type:$this
.... abatement[x]:abatementDateTime SI0..1dateTimeWhen in resolution/remission
... recordedDate SΣ0..1dateTimeDate record was first recorded
... recorder Σ0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Who recorded the condition
... asserter Σ0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Person who asserts this condition
... stage I0..*BackboneElementStage/grade, usually assessed formally
con-1: Stage SHALL have summary or assessment
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... summary I0..1CodeableConceptSimple summary (disease specific)
Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages).

.... assessment I0..*Reference(ClinicalImpression | DiagnosticReport | Observation)Formal record of assessment
.... type 0..1CodeableConceptKind of staging
Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological).

... evidence I0..*BackboneElementSupporting evidence
con-2: evidence SHALL have code or details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣI0..*CodeableConceptManifestation/symptom
Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition.


.... detail ΣI0..*Reference(Resource)Supporting information found elsewhere
... note S0..1AnnotationAdditional information about the Condition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition I0..*USCoreConditionCDMH Condition
... clinicalStatus ?!ΣI0..1CodeableConceptactive | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required)
... verificationStatus ?!ΣI0..1CodeableConceptunconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: ConditionVerificationStatus (required)
... category I1..*CodeableConceptproblem-list-item | encounter-diagnosis | health-concern
Binding: US Core Condition Category Codes (extensible)
.... cdmh-pcornet-condition-source 0..1codePCORNetConditionSource
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..1Reference(CDMH Patient)Who has the condition?
... encounter Σ0..1Reference(CDMH Encounter)Encounter created as part of
... onset[x]:onsetDateTime Σ0..1dateTimeEstimated or actual date, date-time, or age
... abatement[x]:abatementDateTime I0..1dateTimeWhen in resolution/remission
... recordedDate Σ0..1dateTimeDate record was first recorded
... note 0..1AnnotationAdditional information about the Condition

doco 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition 0..*USCoreConditionCDMH Condition
... code
.... cdmh-pcornet-condition-source S0..1codePCORNetConditionSource
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 S1..1Reference(CDMH Patient)Who has the condition?
... encounter S0..1Reference(CDMH Encounter)Encounter created as part of
... abatementDateTime S0..1dateTimeWhen in resolution/remission
... recordedDate S0..1dateTimeDate record was first recorded
... note S0..1AnnotationAdditional information about the Condition

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition I0..*USCoreConditionCDMH Condition
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this condition
... clinicalStatus ?!SΣI0..1CodeableConceptactive | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required)
... verificationStatus ?!SΣI0..1CodeableConceptunconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: ConditionVerificationStatus (required)
... category SI1..*CodeableConceptproblem-list-item | encounter-diagnosis | health-concern
Binding: US Core Condition Category Codes (extensible)
... severity 0..1CodeableConceptSubjective severity of condition
Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician.

... code SΣ1..1CodeableConceptIdentification of the condition, problem or diagnosis
Binding: US Core Condition Code (extensible): Valueset to describe the actual problem experienced by the patient

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... cdmh-pcornet-condition-source S0..1codePCORNetConditionSource
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..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... bodySite Σ0..*CodeableConceptAnatomical location, if relevant
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... subject SΣ1..1Reference(CDMH Patient)Who has the condition?
... encounter SΣ0..1Reference(CDMH Encounter)Encounter created as part of
... Slices for onset[x] Σ0..1dateTimeEstimated or actual date, date-time, or age
Slice: Unordered, Closed by type:$this
.... onset[x]:onsetDateTime SΣ0..1dateTimeEstimated or actual date, date-time, or age
... Slices for abatement[x] I0..1dateTimeWhen in resolution/remission
Slice: Unordered, Closed by type:$this
.... abatement[x]:abatementDateTime SI0..1dateTimeWhen in resolution/remission
... recordedDate SΣ0..1dateTimeDate record was first recorded
... recorder Σ0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Who recorded the condition
... asserter Σ0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Person who asserts this condition
... stage I0..*BackboneElementStage/grade, usually assessed formally
con-1: Stage SHALL have summary or assessment
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... summary I0..1CodeableConceptSimple summary (disease specific)
Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages).

.... assessment I0..*Reference(ClinicalImpression | DiagnosticReport | Observation)Formal record of assessment
.... type 0..1CodeableConceptKind of staging
Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological).

... evidence I0..*BackboneElementSupporting evidence
con-2: evidence SHALL have code or details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣI0..*CodeableConceptManifestation/symptom
Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition.


.... detail ΣI0..*Reference(Resource)Supporting information found elsewhere
... note S0..1AnnotationAdditional information about the Condition

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Condition.languagepreferredCommonLanguages
Max Binding: AllLanguages
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
Condition.verificationStatusrequiredConditionVerificationStatus
Condition.categoryextensibleUSCoreConditionCategoryCodes
Condition.severitypreferredCondition/DiagnosisSeverity
Condition.codeextensibleUSCoreConditionCode
Condition.bodySiteexampleSNOMEDCTBodyStructures
Condition.stage.summaryexampleConditionStage
Condition.stage.typeexampleConditionStageType
Condition.evidence.codeexampleManifestationAndSymptomCodes

Constraints

IdPathDetailsRequirements
con-3ConditionCondition.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-4ConditionIf 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-5ConditionCondition.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-2ConditionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ConditionIf 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-4ConditionIf 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-5ConditionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ConditionA resource should have narrative for robust management
: text.`div`.exists()
us-core-1ConditionA 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-1Condition.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Condition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Condition.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Condition.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Condition.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.clinicalStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.verificationStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.severityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.code.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Condition.code.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Condition.code.extension:pcornet-condition-sourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Condition.code.extension:pcornet-condition-sourceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Condition.code.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.code.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.bodySiteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.onset[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.onset[x]:onsetDateTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.abatement[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.abatement[x]:abatementDateTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.recordedDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.recorderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.asserterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
con-1Condition.stageStage SHALL have summary or assessment
: summary.exists() or assessment.exists()
ele-1Condition.stageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.stage.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Condition.stage.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Condition.stage.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Condition.stage.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Condition.stage.summaryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.stage.assessmentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.stage.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
con-2Condition.evidenceevidence SHALL have code or details
: code.exists() or detail.exists()
ele-1Condition.evidenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.evidence.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Condition.evidence.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Condition.evidence.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Condition.evidence.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Condition.evidence.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.evidence.detailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())