NCPI FHIR Implementation Guide v2
0.2.0 - ci-build
NCPI FHIR Implementation Guide v2 - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-condition-summary | Version: 0.2.0 | |||
| Draft as of 2025-12-03 | Computable Name: NcpiConditionSummary | |||
Information about a condition related to a research participant
The NCPI Condition profile is based on the standard resource type, Observation and is intended to represent a condition or phenotype associated with a participant in a research study.
In order to ensure that our resources are interoperable across studies, we have employed a number of restrictions that should make consuming Patient resources more consistent.
NCPI Condition requests codes for conditions and condition information where possible rather than the use of free text; However, providing free text is an option in the conditionText field of the profile.
The following fields from the shared data model are to be mapped into the NCPI Condition as shown below:
| Logical Model Property | Cardinality | NCPI FHIR Mapping | Usage Guidance | Notes |
|---|---|---|---|---|
| participant | 1..1 | subject | The participant we are describing | |
| condition | 0..* | code.coding | The condition, disease, phenotypic feature, etc that this participant may have. | |
| conditonText | 1..1 | code.text | Detailed description / free text about this condition. | |
| ageAtAssertion | 0..1 | effectiveDateTime | The date or age at which this condition is being asserted. | |
| assertion | 1..1 | valueCodeableConcept | Does the participant have this condition? | |
| conditionType | 0..1 | Category | Does this condition represent a specific "type" of condition, such as "Phenotypic Feature" vs "Disease" in a rare disease setting. | |
| ageAtOnset | 0..1 | component[ageAtOnset] | The age of onset for this condition. Could be expressed with a term, an age, or an age range. | |
| ageAtResolution | 0..1 | component[ageAtResolution] | The age at which this condition was resolved, abated, or cured. Should be left empty in cases of current active status. Could be expressed with a term, an age, or an age range. | |
| otherModifiers | 0..* | component[otherModifiers] | Any additional modifiers for this condition, such as severity. | |
| stage | 0..1 | component[stage] | Cancer staging information | |
| location | 0..* | bodySite | Location information, such as site and/or laterality, of the condition. Multiple values should be interpreted cumulatively, so complex location information, such as "right lung" and "left kidney" may require multiple condition rows. | |
| locationQualifier | 0..1 | extension[codeableConcept] | Any spatial/location qualifiers | |
| lateralityQualifier | 0..1 | extension[codeableConcept] | Any laterality qualifiers | |
| assertionSource | 0..1 | method | Where or how was this this assertion about the Participant recorded? This can support understanding the differences between surveys, automated EHR extraction, manual chart abstraction, etc. | |
| asserter | 0..1 | extension[codeableConcept] | Who recorded this assertion about the Participant? This can support understanding the differences between self-report, doctor, trained research staff. |
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 | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | dateTime | The age in decimal years of the Subject at the time point which the assertion. Could be expressed with a term, an age, or an age range. (for ages use http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime) URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/age-at-event | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Who recorded this assertion about the Participant? This can support understanding the differences between self-report, doctor, trained research staff. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/entity-asserter | |
![]() ![]() ![]() |
0..* | CodeableConcept | Any additional modifiers for this condition, such as severity. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/other-condition-modifiers | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!ΣC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. |
![]() ![]() |
?!ΣC | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis. |
![]() ![]() |
0..* | CodeableConcept | Does this condition represent a specific "type" of condition, such as "Phenotypic Feature" vs "Disease" in a rare disease setting. Binding: ConditionCategoryCodes (extensible): A category assigned to the condition. | |
![]() ![]() |
Σ | 0..* | CodeableConcept | Location information for the condition, including site, laterality, and other qualifiers as appropriate. Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Any location qualifiers URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Laterality information for the condition site URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | |
![]() ![]() |
Σ | 1..1 | Reference(Patient | Group) | The participant we are describing |
![]() ![]() |
Σ | 0..1 | The age of onset for this condition. Could be expressed with a term, an age, or an age range. (for ages use http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime) | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() |
string | |||
![]() ![]() |
C | 0..1 | The age at which this condition was resolved, abated, or cured. Should be left empty in cases of current active status. Could be expressed with a term, an age, or an age range. | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() |
string | |||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Reference to the individual responsible for the assertion, if this information is known (participant's Patient resource, if it is self reported, etc.) |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Condition.clinicalStatus | Base | required | Condition Clinical Status Codes | 📍4.0.1 | FHIR Std. |
| Condition.verificationStatus | Base | required | ConditionVerificationStatus | 📍4.0.1 | FHIR Std. |
| Condition.category | Base | extensible | Condition Category Codes | 📍4.0.1 | FHIR Std. |
| Condition.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 Condition
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Condition | Detailed information about conditions, problems or diagnoses | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | dateTime | The age in decimal years of the Subject at the time point which the assertion. Could be expressed with a term, an age, or an age range. (for ages use http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime) URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/age-at-event | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Who recorded this assertion about the Participant? This can support understanding the differences between self-report, doctor, trained research staff. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/entity-asserter | |
![]() ![]() ![]() |
0..* | CodeableConcept | Any additional modifiers for this condition, such as severity. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/other-condition-modifiers | |
![]() ![]() |
0..* | CodeableConcept | Does this condition represent a specific "type" of condition, such as "Phenotypic Feature" vs "Disease" in a rare disease setting. | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Coding | The condition, disease, phenotypic feature, etc that this participant may have. | |
![]() ![]() ![]() |
0..1 | string | Detailed description / free text about this condition. | |
![]() ![]() |
0..* | CodeableConcept | Location information for the condition, including site, laterality, and other qualifiers as appropriate. | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Any location qualifiers URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Laterality information for the condition site URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | |
![]() ![]() |
1..1 | Reference(Patient | Group) | The participant we are describing | |
![]() ![]() |
0..1 | dateTime, Age, Period, Range, string | The age of onset for this condition. Could be expressed with a term, an age, or an age range. (for ages use http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime) | |
![]() ![]() |
0..1 | dateTime, Age, Period, Range, string | The age at which this condition was resolved, abated, or cured. Should be left empty in cases of current active status. Could be expressed with a term, an age, or an age range. | |
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Reference to the individual responsible for the assertion, if this information is known (participant's Patient resource, if it is self reported, etc.) | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Cancer staging information. Example ValueSet, [condition-stage](https://hl7.org/fhir/R4/valueset-condition-stage.html) | |
Documentation for this format | ||||
| 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): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | dateTime | The age in decimal years of the Subject at the time point which the assertion. Could be expressed with a term, an age, or an age range. (for ages use http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime) URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/age-at-event | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Who recorded this assertion about the Participant? This can support understanding the differences between self-report, doctor, trained research staff. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/entity-asserter | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Any additional modifiers for this condition, such as severity. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/other-condition-modifiers | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | External Ids for this condition | ||||
![]() ![]() |
?!ΣC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. | ||||
![]() ![]() |
?!ΣC | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis. | ||||
![]() ![]() |
0..* | CodeableConcept | Does this condition represent a specific "type" of condition, such as "Phenotypic Feature" vs "Disease" in a rare disease setting. Binding: ConditionCategoryCodes (extensible): A category assigned to the condition. | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | The condition, disease, phenotypic feature, etc that this participant may have. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Detailed description / free text about this condition. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Location information for the condition, including site, laterality, and other qualifiers as appropriate. Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Any location qualifiers URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Laterality information for the condition site URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 1..1 | Reference(Patient | Group) | The participant we are describing | ||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() |
Σ | 0..1 | The age of onset for this condition. Could be expressed with a term, an age, or an age range. (for ages use http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime) | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() |
C | 0..1 | The age at which this condition was resolved, abated, or cured. Should be left empty in cases of current active status. Could be expressed with a term, an age, or an age range. | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() |
Σ | 0..1 | dateTime | Date record was first recorded | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the condition | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Reference to the individual responsible for the assertion, if this information is known (participant's Patient resource, if it is self reported, etc.) | ||||
![]() ![]() |
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 | CodeableConcept | Cancer staging information. Example ValueSet, [condition-stage](https://hl7.org/fhir/R4/valueset-condition-stage.html) Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages). | ||||
![]() ![]() ![]() |
C | 0..* | Reference(ClinicalImpression | DiagnosticReport | Observation) | Formal record of assessment | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | 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..* | CodeableConcept | Manifestation/symptom Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition. | ||||
![]() ![]() ![]() |
ΣC | 0..* | Reference(Resource) | Supporting information found elsewhere | ||||
![]() ![]() |
0..* | Annotation | Additional information about the Condition | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Condition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Condition.clinicalStatus | Base | required | Condition Clinical Status Codes | 📍4.0.1 | FHIR Std. |
| Condition.verificationStatus | Base | required | ConditionVerificationStatus | 📍4.0.1 | FHIR Std. |
| Condition.category | Base | extensible | Condition Category Codes | 📍4.0.1 | FHIR Std. |
| Condition.severity | Base | preferred | Condition/Diagnosis Severity | 📍4.0.1 | FHIR Std. |
| Condition.code | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| Condition.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Condition.stage.summary | Base | example | Condition Stage | 📍4.0.1 | FHIR Std. |
| Condition.stage.type | Base | example | Condition Stage Type | 📍4.0.1 | FHIR Std. |
| Condition.evidence.code | Base | example | Manifestation and Symptom Codes | 📍4.0.1 | 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 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 Condition
Summary
Extensions
This structure refers to these extensions:
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 | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | dateTime | The age in decimal years of the Subject at the time point which the assertion. Could be expressed with a term, an age, or an age range. (for ages use http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime) URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/age-at-event | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Who recorded this assertion about the Participant? This can support understanding the differences between self-report, doctor, trained research staff. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/entity-asserter | |
![]() ![]() ![]() |
0..* | CodeableConcept | Any additional modifiers for this condition, such as severity. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/other-condition-modifiers | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!ΣC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. |
![]() ![]() |
?!ΣC | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis. |
![]() ![]() |
0..* | CodeableConcept | Does this condition represent a specific "type" of condition, such as "Phenotypic Feature" vs "Disease" in a rare disease setting. Binding: ConditionCategoryCodes (extensible): A category assigned to the condition. | |
![]() ![]() |
Σ | 0..* | CodeableConcept | Location information for the condition, including site, laterality, and other qualifiers as appropriate. Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Any location qualifiers URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Laterality information for the condition site URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | |
![]() ![]() |
Σ | 1..1 | Reference(Patient | Group) | The participant we are describing |
![]() ![]() |
Σ | 0..1 | The age of onset for this condition. Could be expressed with a term, an age, or an age range. (for ages use http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime) | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() |
string | |||
![]() ![]() |
C | 0..1 | The age at which this condition was resolved, abated, or cured. Should be left empty in cases of current active status. Could be expressed with a term, an age, or an age range. | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() |
string | |||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Reference to the individual responsible for the assertion, if this information is known (participant's Patient resource, if it is self reported, etc.) |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Condition.clinicalStatus | Base | required | Condition Clinical Status Codes | 📍4.0.1 | FHIR Std. |
| Condition.verificationStatus | Base | required | ConditionVerificationStatus | 📍4.0.1 | FHIR Std. |
| Condition.category | Base | extensible | Condition Category Codes | 📍4.0.1 | FHIR Std. |
| Condition.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
Differential View
This structure is derived from Condition
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Condition | Detailed information about conditions, problems or diagnoses | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | dateTime | The age in decimal years of the Subject at the time point which the assertion. Could be expressed with a term, an age, or an age range. (for ages use http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime) URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/age-at-event | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Who recorded this assertion about the Participant? This can support understanding the differences between self-report, doctor, trained research staff. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/entity-asserter | |
![]() ![]() ![]() |
0..* | CodeableConcept | Any additional modifiers for this condition, such as severity. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/other-condition-modifiers | |
![]() ![]() |
0..* | CodeableConcept | Does this condition represent a specific "type" of condition, such as "Phenotypic Feature" vs "Disease" in a rare disease setting. | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Coding | The condition, disease, phenotypic feature, etc that this participant may have. | |
![]() ![]() ![]() |
0..1 | string | Detailed description / free text about this condition. | |
![]() ![]() |
0..* | CodeableConcept | Location information for the condition, including site, laterality, and other qualifiers as appropriate. | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Any location qualifiers URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Laterality information for the condition site URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | |
![]() ![]() |
1..1 | Reference(Patient | Group) | The participant we are describing | |
![]() ![]() |
0..1 | dateTime, Age, Period, Range, string | The age of onset for this condition. Could be expressed with a term, an age, or an age range. (for ages use http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime) | |
![]() ![]() |
0..1 | dateTime, Age, Period, Range, string | The age at which this condition was resolved, abated, or cured. Should be left empty in cases of current active status. Could be expressed with a term, an age, or an age range. | |
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Reference to the individual responsible for the assertion, if this information is known (participant's Patient resource, if it is self reported, etc.) | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Cancer staging information. Example ValueSet, [condition-stage](https://hl7.org/fhir/R4/valueset-condition-stage.html) | |
Documentation for this format | ||||
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): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | dateTime | The age in decimal years of the Subject at the time point which the assertion. Could be expressed with a term, an age, or an age range. (for ages use http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime) URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/age-at-event | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Who recorded this assertion about the Participant? This can support understanding the differences between self-report, doctor, trained research staff. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/entity-asserter | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Any additional modifiers for this condition, such as severity. URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/other-condition-modifiers | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | External Ids for this condition | ||||
![]() ![]() |
?!ΣC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. | ||||
![]() ![]() |
?!ΣC | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis. | ||||
![]() ![]() |
0..* | CodeableConcept | Does this condition represent a specific "type" of condition, such as "Phenotypic Feature" vs "Disease" in a rare disease setting. Binding: ConditionCategoryCodes (extensible): A category assigned to the condition. | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | The condition, disease, phenotypic feature, etc that this participant may have. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Detailed description / free text about this condition. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Location information for the condition, including site, laterality, and other qualifiers as appropriate. Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Any location qualifiers URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Laterality information for the condition site URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 1..1 | Reference(Patient | Group) | The participant we are describing | ||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() |
Σ | 0..1 | The age of onset for this condition. Could be expressed with a term, an age, or an age range. (for ages use http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime) | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() |
C | 0..1 | The age at which this condition was resolved, abated, or cured. Should be left empty in cases of current active status. Could be expressed with a term, an age, or an age range. | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() |
Σ | 0..1 | dateTime | Date record was first recorded | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the condition | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Reference to the individual responsible for the assertion, if this information is known (participant's Patient resource, if it is self reported, etc.) | ||||
![]() ![]() |
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 | CodeableConcept | Cancer staging information. Example ValueSet, [condition-stage](https://hl7.org/fhir/R4/valueset-condition-stage.html) Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages). | ||||
![]() ![]() ![]() |
C | 0..* | Reference(ClinicalImpression | DiagnosticReport | Observation) | Formal record of assessment | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | 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..* | CodeableConcept | Manifestation/symptom Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition. | ||||
![]() ![]() ![]() |
ΣC | 0..* | Reference(Resource) | Supporting information found elsewhere | ||||
![]() ![]() |
0..* | Annotation | Additional information about the Condition | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Condition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Condition.clinicalStatus | Base | required | Condition Clinical Status Codes | 📍4.0.1 | FHIR Std. |
| Condition.verificationStatus | Base | required | ConditionVerificationStatus | 📍4.0.1 | FHIR Std. |
| Condition.category | Base | extensible | Condition Category Codes | 📍4.0.1 | FHIR Std. |
| Condition.severity | Base | preferred | Condition/Diagnosis Severity | 📍4.0.1 | FHIR Std. |
| Condition.code | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| Condition.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Condition.stage.summary | Base | example | Condition Stage | 📍4.0.1 | FHIR Std. |
| Condition.stage.type | Base | example | Condition Stage Type | 📍4.0.1 | FHIR Std. |
| Condition.evidence.code | Base | example | Manifestation and Symptom Codes | 📍4.0.1 | 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 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 Condition
Summary
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron