This page is part of the Retrieval of Real World Data for Clinical Research (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Active as of 2022-12-04 |
Definitions for the ConditionRwd resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Condition | |
2. Condition.encounter | |
Must Support | true |
3. Condition.recordedDate | |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here.
1. Condition | ||||||||||
Definition | A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. | |||||||||
Control | 0..* | |||||||||
Invariants | Defined on this element con-3: 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: 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.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: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) | |||||||||
2. Condition.implicitRules | ||||||||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |||||||||
Control | 0..1 | |||||||||
Type | uri | |||||||||
Is Modifier | true | |||||||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
3. Condition.modifierExtension | ||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||
Control | 0..* | |||||||||
Type | Extension | |||||||||
Is Modifier | true | |||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||
Alternate Names | extensions, user content | |||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||||||||
4. Condition.clinicalStatus | ||||||||||
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. The clinical status of the condition. | |||||||||
Control | 10..1 This element is affected by the following invariants: ele-1, con-3, con-4, con-5 | |||||||||
Binding | The codes SHALL be taken from ConditionClinicalStatusCodes The clinical status of the condition or diagnosis. | |||||||||
Type | CodeableConcept(CodeableConceptIPS) | |||||||||
Must Support | true | |||||||||
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
5. Condition.category | ||||||||||
Definition | A category assigned to the condition. In this profile, a health problem of the patient, therefore a 'problem-list-item'. A category assigned to the condition. | |||||||||
Control | 0..* This element is affected by the following invariants: ele-1 | |||||||||
Binding | The codes SHOULD be taken from Problem Type - IPSThe codes SHALL be taken from ConditionCategoryCodes; other codes may be used where these codes are not suitable
| |||||||||
Type | CodeableConcept(CodeableConceptIPS) | |||||||||
Must Support | true | |||||||||
Comments | In this profile, Condition represents a health problem of the patient. Therefore one of the category value(s) must be problem-list-item. The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
6. Condition.severity | ||||||||||
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. A subjective assessment of the severity of the condition as evaluated by the clinician. | |||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | |||||||||
Binding | The codes SHOULD be taken from Condition/DiagnosisSeverity
| |||||||||
Type | CodeableConcept(CodeableConceptIPS) | |||||||||
Must Support | true | |||||||||
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Coding of the severity with a terminology is preferred, where possible. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
7. Condition.code | ||||||||||
Definition | Identification of the condition, problem or diagnosis or recording of "problem absent" or of "problems unknown". Identification of the condition, problem or diagnosis. | |||||||||
Control | 10..1 This element is affected by the following invariants: ele-1 | |||||||||
Binding | The codes SHOULD be taken from Problems - SNOMED CT + Absent/Unknown - IPSFor example codes, see Condition/Problem/DiagnosisCodes Code for a clinical problem that is selected from SNOMED CT or a code for absent/unknown problem Identification of the condition or diagnosis.
| |||||||||
Type | CodeableConcept(CodeableConceptIPS) | |||||||||
Must Support | true | |||||||||
Requirements | 0..1 to account for primarily narrative only resources. | |||||||||
Alternate Names | type | |||||||||
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
8. Condition.subject | ||||||||||
Definition | Indicates the patient or group who the condition record is associated with. | |||||||||
Control | 1..1 | |||||||||
Type | Reference(PatientUvIps|Patient|Group) | |||||||||
Must Support | true | |||||||||
Requirements | Group is typically used for veterinary or public health use cases. | |||||||||
Alternate Names | patient | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
9. Condition.subject.reference | ||||||||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | |||||||||
Control | 10..1 This element is affected by the following invariants: ref-1 | |||||||||
Type | string | |||||||||
Must Support | true | |||||||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
10. Condition.encounter | ||||||||||
Definition | The Encounter during which this Condition was created or to which the creation of this record is tightly associated. | |||||||||
Control | 0..1 | |||||||||
Type | Reference(Encounter) | |||||||||
Must Support | true | |||||||||
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. This record indicates the encounter this particular record is associated with. In the case of a "new" diagnosis reflecting ongoing/revised information about the condition, this might be distinct from the first encounter in which the underlying condition was first "known". | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
11. Condition.onset[x] | ||||||||||
Definition | Estimated or actual date or date-time the condition began, in the opinion of the clinician. | |||||||||
Control | 0..1 | |||||||||
Type | Choice of: dateTime, Age, Period, Range, string | |||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | |||||||||
Must Support | true | |||||||||
Must Support Types | dateTime | |||||||||
Comments | Age is generally used when the patient reports an age at which the Condition began to occur. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
12. Condition.recordedDate | ||||||||||
Definition | The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date. | |||||||||
Control | 0..1 | |||||||||
Type | dateTime | |||||||||
Must Support | true | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here.
1. Condition | ||||||||||
Definition | A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. | |||||||||
Control | 0..* | |||||||||
2. Condition.id | ||||||||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |||||||||
Control | 0..1 | |||||||||
Type | id | |||||||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | |||||||||
3. Condition.meta | ||||||||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |||||||||
Control | 0..1 | |||||||||
Type | Meta | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
4. Condition.implicitRules | ||||||||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |||||||||
Control | 0..1 | |||||||||
Type | uri | |||||||||
Is Modifier | true | |||||||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
5. Condition.language | ||||||||||
Definition | The base language in which the resource is written. | |||||||||
Control | 0..1 | |||||||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language
| |||||||||
Type | code | |||||||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
6. Condition.text | ||||||||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |||||||||
Control | 0..1 | |||||||||
Type | Narrative | |||||||||
Alternate Names | narrative, html, xhtml, display | |||||||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
7. Condition.contained | ||||||||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |||||||||
Control | 0..* | |||||||||
Type | Resource | |||||||||
Alternate Names | inline resources, anonymous resources, contained resources | |||||||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | |||||||||
8. Condition.extension | ||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||
Control | 0..* | |||||||||
Type | Extension | |||||||||
Alternate Names | extensions, user content | |||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||||||||
9. Condition.modifierExtension | ||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||
Control | 0..* | |||||||||
Type | Extension | |||||||||
Is Modifier | true | |||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||
Alternate Names | extensions, user content | |||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||||||||
10. Condition.identifier | ||||||||||
Definition | Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server. | |||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||
Control | 0..* | |||||||||
Type | Identifier | |||||||||
Requirements | Allows identification of the condition as it is known by various participating systems and in a way that remains consistent across servers. | |||||||||
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
11. Condition.clinicalStatus | ||||||||||
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | |||||||||
Control | 1..1 This element is affected by the following invariants: ele-1 | |||||||||
Binding | The codes SHALL be taken from ConditionClinicalStatusCodes The clinical status of the condition or diagnosis | |||||||||
Type | CodeableConcept(CodeableConceptIPS) | |||||||||
Must Support | true | |||||||||
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
12. Condition.verificationStatus | ||||||||||
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | |||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | |||||||||
Binding | The codes SHALL be taken from ConditionVerificationStatus The verification status to support or decline the clinical status of the condition or diagnosis | |||||||||
Type | CodeableConcept(CodeableConceptIPS) | |||||||||
Comments | This element is labeled as a modifier because the status contains the code refuted and entered-in-error that mark the Condition as not currently valid. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
13. Condition.category | ||||||||||
Definition | A category assigned to the condition. In this profile, a health problem of the patient, therefore a 'problem-list-item'. | |||||||||
Control | 0..* This element is affected by the following invariants: ele-1 | |||||||||
Binding | The codes SHOULD be taken from Problem Type - IPS
| |||||||||
Type | CodeableConcept(CodeableConceptIPS) | |||||||||
Must Support | true | |||||||||
Comments | In this profile, Condition represents a health problem of the patient. Therefore one of the category value(s) must be problem-list-item. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
14. Condition.severity | ||||||||||
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | |||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | |||||||||
Binding | The codes SHOULD be taken from Condition/DiagnosisSeverity
| |||||||||
Type | CodeableConcept(CodeableConceptIPS) | |||||||||
Must Support | true | |||||||||
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
15. Condition.code | ||||||||||
Definition | Identification of the condition, problem or diagnosis or recording of "problem absent" or of "problems unknown". | |||||||||
Control | 1..1 This element is affected by the following invariants: ele-1 | |||||||||
Binding | The codes SHOULD be taken from Problems - SNOMED CT + Absent/Unknown - IPS
Code for a clinical problem that is selected from SNOMED CT or a code for absent/unknown proble
| |||||||||
Type | CodeableConcept(CodeableConceptIPS) | |||||||||
Must Support | true | |||||||||
Requirements | 0..1 to account for primarily narrative only resources. | |||||||||
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
16. Condition.bodySite | ||||||||||
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | |||||||||
Control | 0..* This element is affected by the following invariants: ele-1 | |||||||||
Binding | For example codes, see SNOMEDCTBodyStructures | |||||||||
Type | CodeableConcept(CodeableConceptIPS) | |||||||||
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
17. Condition.subject | ||||||||||
Definition | Indicates the patient or group who the condition record is associated with. | |||||||||
Control | 1..1 | |||||||||
Type | Reference(PatientUvIps) | |||||||||
Must Support | true | |||||||||
Requirements | Group is typically used for veterinary or public health use cases. | |||||||||
Alternate Names | patient | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
18. Condition.subject.id | ||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||
Control | 0..1 | |||||||||
Type | string | |||||||||
XML Representation | In the XML format, this property is represented as an attribute. | |||||||||
19. Condition.subject.extension | ||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||
Control | 0..* | |||||||||
Type | Extension | |||||||||
Alternate Names | extensions, user content | |||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||||||||
Slicing | This element introduces a set of slices on Condition.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| |||||||||
20. Condition.subject.reference | ||||||||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | |||||||||
Control | 1..1 This element is affected by the following invariants: ref-1 | |||||||||
Type | string | |||||||||
Must Support | true | |||||||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
21. Condition.subject.type | ||||||||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | |||||||||
Control | 0..1 | |||||||||
Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model) | |||||||||
Type | uri | |||||||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
22. Condition.subject.identifier | ||||||||||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | |||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||
Control | 0..1 | |||||||||
Type | Identifier | |||||||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
23. Condition.subject.display | ||||||||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |||||||||
Control | 0..1 | |||||||||
Type | string | |||||||||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
24. Condition.encounter | ||||||||||
Definition | The Encounter during which this Condition was created or to which the creation of this record is tightly associated. | |||||||||
Control | 0..1 | |||||||||
Type | Reference(Encounter) | |||||||||
Must Support | true | |||||||||
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. This record indicates the encounter this particular record is associated with. In the case of a "new" diagnosis reflecting ongoing/revised information about the condition, this might be distinct from the first encounter in which the underlying condition was first "known". | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
25. Condition.onset[x] | ||||||||||
Definition | Estimated or actual date or date-time the condition began, in the opinion of the clinician. | |||||||||
Control | 0..1 | |||||||||
Type | Choice of: dateTime, Age, Period, Range, string | |||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | |||||||||
Must Support | true | |||||||||
Must Support Types | dateTime | |||||||||
Comments | Age is generally used when the patient reports an age at which the Condition began to occur. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
26. Condition.abatement[x] | ||||||||||
Definition | The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate. | |||||||||
Control | 0..1 This element is affected by the following invariants: con-4 | |||||||||
Type | Choice of: dateTime, Age, Period, Range, string | |||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | |||||||||
Comments | There is no explicit distinction between resolution and remission because in many cases the distinction is not clear. Age is generally used when the patient reports an age at which the Condition abated. If there is no abatement element, it is unknown whether the condition has resolved or entered remission; applications and users should generally assume that the condition is still valid. When abatementString exists, it implies the condition is abated. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
27. Condition.recordedDate | ||||||||||
Definition | The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date. | |||||||||
Control | 0..1 | |||||||||
Type | dateTime | |||||||||
Must Support | true | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
28. Condition.recorder | ||||||||||
Definition | Individual who recorded the record and takes responsibility for its content. | |||||||||
Control | 0..1 | |||||||||
Type | Reference(Practitioner|PractitionerRole|Patient|RelatedPerson) | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
29. Condition.asserter | ||||||||||
Definition | Individual who is making the condition statement. | |||||||||
Control | 0..1 | |||||||||
Type | Reference(Practitioner|PractitionerRole|Patient|RelatedPerson) | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
30. Condition.stage | ||||||||||
Definition | Clinical stage or grade of a condition. May include formal severity assessments. | |||||||||
Control | 0..* | |||||||||
Type | BackboneElement | |||||||||
Invariants | Defined on this element con-1: Stage SHALL have summary or assessment (: summary.exists() or assessment.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
31. Condition.stage.id | ||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||
Control | 0..1 | |||||||||
Type | string | |||||||||
XML Representation | In the XML format, this property is represented as an attribute. | |||||||||
32. Condition.stage.extension | ||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||
Control | 0..* | |||||||||
Type | Extension | |||||||||
Alternate Names | extensions, user content | |||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||||||||
33. Condition.stage.modifierExtension | ||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||
Control | 0..* | |||||||||
Type | Extension | |||||||||
Is Modifier | true | |||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||
Alternate Names | extensions, user content, modifiers | |||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||||||||
34. Condition.stage.summary | ||||||||||
Definition | A simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific. | |||||||||
Control | 0..1 This element is affected by the following invariants: con-1 | |||||||||
Binding | For example codes, see ConditionStage Codes describing condition stages (e.g. Cancer stages) | |||||||||
Type | CodeableConcept | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
35. Condition.stage.assessment | ||||||||||
Definition | Reference to a formal record of the evidence on which the staging assessment is based. | |||||||||
Control | 0..* This element is affected by the following invariants: con-1 | |||||||||
Type | Reference(ClinicalImpression|DiagnosticReport|Observation) | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
36. Condition.stage.type | ||||||||||
Definition | The kind of staging, such as pathological or clinical staging. | |||||||||
Control | 0..1 | |||||||||
Binding | For example codes, see ConditionStageType Codes describing the kind of condition staging (e.g. clinical or pathological) | |||||||||
Type | CodeableConcept | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
37. Condition.evidence | ||||||||||
Definition | Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition. | |||||||||
Control | 0..* | |||||||||
Type | BackboneElement | |||||||||
Comments | The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both. | |||||||||
Invariants | Defined on this element con-2: evidence SHALL have code or details (: code.exists() or detail.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
38. Condition.evidence.id | ||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||
Control | 0..1 | |||||||||
Type | string | |||||||||
XML Representation | In the XML format, this property is represented as an attribute. | |||||||||
39. Condition.evidence.extension | ||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||
Control | 0..* | |||||||||
Type | Extension | |||||||||
Alternate Names | extensions, user content | |||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||||||||
40. Condition.evidence.modifierExtension | ||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||
Control | 0..* | |||||||||
Type | Extension | |||||||||
Is Modifier | true | |||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||
Alternate Names | extensions, user content, modifiers | |||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||||||||
41. Condition.evidence.code | ||||||||||
Definition | A manifestation or symptom that led to the recording of this condition. | |||||||||
Control | 0..* This element is affected by the following invariants: con-2 | |||||||||
Binding | For example codes, see ManifestationAndSymptomCodes Codes that describe the manifestation or symptoms of a condition | |||||||||
Type | CodeableConcept | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
42. Condition.evidence.detail | ||||||||||
Definition | Links to other relevant information, including pathology reports. | |||||||||
Control | 0..* This element is affected by the following invariants: con-2 | |||||||||
Type | Reference(Resource) | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||||||||
43. Condition.note | ||||||||||
Definition | Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis. | |||||||||
Control | 0..* | |||||||||
Type | Annotation | |||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |