Condition | I | | Condition | There are no (further) constraints on this element Element idShort description Detailed information about conditions, problems or diagnoses Definition A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
Data type Condition Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - 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() - 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-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()
Mappings- rim: Entity. Role, or Act
- workflow: Event
- sct-concept: < 243796009 |Situation with explicit context| : 246090004 |Associated finding| = ( ( < 404684003 |Clinical finding| MINUS ( << 420134006 |Propensity to adverse reactions| OR << 473010000 |Hypersensitivity condition| OR << 79899007 |Drug interaction| OR << 69449002 |Drug action| OR << 441742003 |Evaluation finding| OR << 307824009 |Administrative status| OR << 385356007 |Tumor stage finding|)) OR < 272379006 |Event|)
- v2: PPR message
- rim: Observation[classCode=OBS, moodCode=EVN, code=ASSERTION, value<Diagnosis]
|
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idShort description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
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.
Data type string |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idShort description Metadata about the resource 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.
Data type Meta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idShort description A set of rules under which this content was created 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.
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.
Data type uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idShort description Language of the resource content Definition The base language in which the resource is written.
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).
Data type code Binding CommonLanguages (preferred)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
text | | 0..1 | Narrative | There are no (further) constraints on this element Element idShort description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display 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.
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.
Data type Narrative Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- rim: Act.text?
|
contained | | 0..* | Resource | There are no (further) constraints on this element Element idShort description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources 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.
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.
Data type Resource Mappings- rim: Entity. Role, or Act
- rim: N/A
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idShort description Additional content defined by implementations Alternate names extensions, user content 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.
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.
Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- 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()
Mappings |
assertedDate | I | 0..1 | Extension(dateTime) | Element idCondition.extension:assertedDate Short description Date the condition was first asserted Alternate names extensions, user content Definition The date on which the existence of the Condition was first asserted or acknowledged.
Comments At the time this profile is released, the assertedDate extension is undergoing review by the Patient Care Working Group at HL7 International. Receiving systems are expected not to error if this information is received. This specification will further evaluate additional server expectations on assertedDate following resolution.
Data type Extension(dateTime) Extension URL http://hl7.org/fhir/StructureDefinition/condition-assertedDate Constraints- 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()
Mappings- rim: n/a
- rim: N/A
- pCHDCF: Health Concern Date of Diagnosis*
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCondition.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content 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).
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.
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.
Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- 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()
Mappings |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idShort description External Ids for this condition 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.
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.
Data type Identifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- workflow: Event.identifier
- w5: FiveWs.identifier
- rim: .id
|
clinicalStatus | Σ ?! I | 0..1 | CodeableConceptBinding | Element idShort description active | recurrence | relapse | inactive | remission | resolved Definition The clinical status of the condition.
Comments 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.
Data type CodeableConcept Binding The clinical status of the condition or diagnosis.
ConditionClinicalStatusCodes (required)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow: Event.status
- w5: FiveWs.status
- sct-concept: < 303105007 |Disease phases|
- v2: PRB-14
- rim: Observation ACT
.inboundRelationship[typeCode=COMP].source[classCode=OBS, code="clinicalStatus", moodCode=EVN].value
- pCHDCF: Health Concern Clinical Status
|
verificationStatus | Σ ?! I | 0..1 | CodeableConceptBinding | Element idCondition.verificationStatus Short description unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Definition The verification status to support the clinical status of the condition.
Comments verificationStatus is not required. For example, when a patient has abdominal pain in the ED, there is not likely going to be a verification status.
The data type is CodeableConcept because verificationStatus 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.
Data type CodeableConcept Binding The verification status to support or decline the clinical status of the condition or diagnosis.
ConditionVerificationStatus (required)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow: Event.status
- w5: FiveWs.status
- sct-concept: < 410514004 |Finding context value|
- v2: PRB-13
- rim: Observation ACT
.inboundRelationship[typeCode=COMP].source[classCode=OBS, code="verificationStatus", moodCode=EVN].value
- sct-attr: 408729009
- pCHDCF: Health Concern Verification Status
|
category | | 0..* | CodeableConceptBinding | Element idShort description problem-list-item | encounter-diagnosis Definition A category assigned to the condition.
Comments The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts.
Data type CodeableConcept Binding A category assigned to the condition.
ConditionCategoryCodes (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.class
- sct-concept: < 404684003 |Clinical finding|
- v2: 'problem' if from PRB-3. 'diagnosis' if from DG1 segment in PV1 message
- rim: .code
- pCHDCF: Health Concern Category
|
severity | | 0..1 | CodeableConceptBinding | Element idShort description Subjective severity of condition Definition A subjective assessment of the severity of the condition as evaluated by the clinician.
Comments Coding of the severity with a terminology is preferred, where possible.
Data type CodeableConcept Binding A subjective assessment of the severity of the condition as evaluated by the clinician.
package/valueset-severitycode.json (preferred)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.grade
- sct-concept: < 272141005 |Severities|
- v2: PRB-26 / ABS-3
- rim: Can be pre/post-coordinated into value. Or ./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="severity"].value
- sct-attr: 246112005
- pCHDCF: Health Concern Severity
|
code | Σ | 0..1 | CodeableConceptBinding | Element idShort description Identification of the condition, problem or diagnosis Alternate names type Definition Identification of the condition, problem or diagnosis.
Requirements 0..1 to account for primarily narrative only resources.
Comments The additionalBinding extension will be used to express the valueSet for additional negation/exclusion codes for reporting the known absence of conditions. At the time of this release, the publisher of the current ValueSet for absence codes (IPS) is developing a SNOMED ValueSet that will replace the current http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-problems-uv-ips
Data type CodeableConcept Binding Identification of the condition or diagnosis.
https://fhir.infoway-inforoute.ca/ValueSet/PHCVScode (preferred)Additional bindings: Per pCHDCF: ICD is recommended as an alternate value set to support physician billing in Canada and as a classification for reporting and analysis
Per pCHDCF: ICD is recommended as an alternate value set to support physician billing in Canada and as a classification for reporting and analysis
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow: Event.code
- w5: FiveWs.what[x]
- sct-concept: code 246090004 |Associated finding| (< 404684003 |Clinical finding| MINUS
<< 420134006 |Propensity to adverse reactions| MINUS
<< 473010000 |Hypersensitivity condition| MINUS
<< 79899007 |Drug interaction| MINUS
<< 69449002 |Drug action| MINUS
<< 441742003 |Evaluation finding| MINUS
<< 307824009 |Administrative status| MINUS
<< 385356007 |Tumor stage finding|)
OR < 413350009 |Finding with explicit context|
OR < 272379006 |Event|
- v2: PRB-3
- rim: .value
- sct-attr: 246090004
- pCHDCF: Health Concern(s)
|
bodySite | Σ | 0..* | CodeableConceptBinding | Element idShort description Anatomical location, if relevant Definition The anatomical location where this condition manifests itself.
Comments Only used if not implicit in code found in Condition.code. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both.
Data type CodeableConcept Binding Codes describing anatomical locations. May include laterality.
package/valueset-anatomicaloracquiredbodystructurecode.json (preferred)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 442083009 |Anatomical or acquired body structure|
- rim: .targetBodySiteCode
- sct-attr: 363698007
- pCHDCF: Health Concern Body Site
|
subject | Σ I | 1..1 | Reference(package/structuredefinition-patient-ca-core.json) | Element idShort description Who has the condition? Alternate names patient Definition Indicates the patient or group who the condition record is associated with.
Requirements Group is typically used for veterinary or public health use cases.
Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data type Reference(package/structuredefinition-patient-ca-core.json) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow: Event.subject
- w5: FiveWs.subject[x]
- v2: PID-3
- rim: .participation[typeCode=SBJ].role[classCode=PAT]
- w5: FiveWs.subject
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idShort description Encounter created as part of Definition The Encounter during which this Condition was created or to which the creation of this record is tightly associated.
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".
Data type Reference(Encounter) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow: Event.context
- w5: FiveWs.context
- v2: PV1-19 (+PV1-54)
- rim: .inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
|
onset[x] | Σ | 0..1 | | Element idShort description Estimated or actual date, date-time, or age Definition Estimated or actual date or date-time the condition began, in the opinion of the clinician.
Comments Age is generally used when the patient reports an age at which the Condition began to occur.
Sliced: Unordered, Open, by $this(Type) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- workflow: Event.occurrence[x]
- w5: FiveWs.init
- v2: PRB-16
- rim: .effectiveTime.low or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="age at onset"].value
- pCHDCF: Health Concern Date of Onset*
|
onsetAge | | | Age | There are no (further) constraints on this element Data type Age |
onsetPeriod | | | Period | There are no (further) constraints on this element Data type Period |
onsetRange | | | Range | There are no (further) constraints on this element Data type Range |
onsetString | | | string | There are no (further) constraints on this element Data type string |
onsetDateTime | Σ | 0..1 | dateTime | Element idCondition.onset[x]:onsetDateTime Short description Estimated or actual date, date-time, or age Definition Estimated or actual date or date-time the condition began, in the opinion of the clinician.
Comments Age is generally used when the patient reports an age at which the Condition began to occur.
Data type dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- workflow: Event.occurrence[x]
- w5: FiveWs.init
- v2: PRB-16
- rim: .effectiveTime.low or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="age at onset"].value
- pCHDCF: Health Concern Date of Onset
|
abatement[x] | I | 0..1 | | Element idShort description When in resolution/remission 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.
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.
Sliced: Unordered, Open, by $this(Type) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- w5: FiveWs.done[x]
- rim: .effectiveTime.high or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="age at remission"].value or .inboundRelationship[typeCode=SUBJ]source[classCode=CONC, moodCode=EVN].status=completed
- pCHDCF: Health Concern Date of Resolution*
|
abatementAge | | | Age | There are no (further) constraints on this element Data type Age |
abatementPeriod | | | Period | There are no (further) constraints on this element Data type Period |
abatementRange | | | Range | There are no (further) constraints on this element Data type Range |
abatementString | | | string | There are no (further) constraints on this element Data type string |
abatementDateTime | I | 0..1 | dateTime | Element idCondition.abatement[x]:abatementDateTime Short description When in resolution/remission 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.
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.
Data type dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- w5: FiveWs.done[x]
- rim: .effectiveTime.high or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="age at remission"].value or .inboundRelationship[typeCode=SUBJ]source[classCode=CONC, moodCode=EVN].status=completed
- pCHDCF: Health Concern Date of Resolution
|
recordedDate | Σ | 0..1 | dateTime | Element idShort description Date record was first recorded Definition The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.
Data type dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- w5: FiveWs.recorded
- v2: REL-11
- rim: .participation[typeCode=AUT].time
- pCHDCF: Health Concern Date of Diagnosis*
|
recorder | Σ I | 0..1 | Reference(package/structuredefinition-practitioner-ca-core.json | Practitioner | package/structuredefinition-practitionerrole-ca-core.json | PractitionerRole | package/structuredefinition-patient-ca-core.json | Patient | RelatedPerson) | Element idShort description Who recorded the condition Definition Individual who recorded the record and takes responsibility for its content.
Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data type Reference(package/structuredefinition-practitioner-ca-core.json | Practitioner | package/structuredefinition-practitionerrole-ca-core.json | PractitionerRole | package/structuredefinition-patient-ca-core.json | Patient | RelatedPerson) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- w5: FiveWs.author
- rim: .participation[typeCode=AUT].role
- pCHDCF: Health Concern Specialist Details*
|
asserter | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | There are no (further) constraints on this element Element idShort description Person who asserts this condition Definition Individual who is making the condition statement.
Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data type Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- w5: FiveWs.source
- v2: REL-7.1 identifier + REL-7.12 type code
- rim: .participation[typeCode=INF].role
|
stage | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idShort description Stage/grade, usually assessed formally Definition Clinical stage or grade of a condition. May include formal severity assessments.
Data type BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - con-1: Stage SHALL have summary or assessment
summary.exists() or assessment.exists()
Mappings- rim: n/a
- rim: ./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="stage/grade"]
|
id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type string Mappings |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCondition.stage.extension Short description Additional content defined by implementations Alternate names extensions, user content 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.
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.
Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- 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()
Mappings |
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCondition.stage.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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).
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.
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.
Data type Extension Constraints- 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()
Mappings |
summary | I | 0..1 | CodeableConcept | Element idShort description Simple summary (disease specific) Definition A simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific.
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.
Data type CodeableConcept Binding Codes describing condition stages (e.g. Cancer stages).
ConditionStage (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept: < 254291000 |Staging and scales|
- v2: PRB-14
- rim: .value
- pCHDCF: Health Concern Stage Summary
|
assessment | I | 0..* | Reference(ClinicalImpression | DiagnosticReport | Observation) | Element idCondition.stage.assessment Short description Formal record of assessment Definition Reference to a formal record of the evidence on which the staging assessment is based.
Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data type Reference(ClinicalImpression | DiagnosticReport | Observation) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim: .self
- pCHDCF: Health Concern Stage Assessment
|
type | | 0..1 | CodeableConcept | Element idShort description Kind of staging Definition The kind of staging, such as pathological or clinical staging.
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.
Data type CodeableConcept Binding Codes describing the kind of condition staging (e.g. clinical or pathological).
ConditionStageType (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim: ./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="stage type"]
- pCHDCF: Health Concern Stage Type
|
evidence | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idShort description Supporting evidence Definition Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.
Comments The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both.
Data type BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - con-2: evidence SHALL have code or details
code.exists() or detail.exists()
Mappings- rim: n/a
- rim: .outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN]
|
id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type string Mappings |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCondition.evidence.extension Short description Additional content defined by implementations Alternate names extensions, user content 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.
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.
Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- 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()
Mappings |
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCondition.evidence.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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).
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.
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.
Data type Extension Constraints- 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()
Mappings |
code | Σ I | 0..* | CodeableConcept | Element idShort description Manifestation/symptom Definition A manifestation or symptom that led to the recording of this condition.
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.
Data type CodeableConcept Binding Codes that describe the manifestation or symptoms of a condition.
ManifestationAndSymptomCodes (example)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow: Event.reasonCode
- w5: FiveWs.why[x]
- sct-concept: < 404684003 |Clinical finding|
- rim: [code="diagnosis"].value
- pCHDCF: Health Concern Evidence Code
|
detail | Σ I | 0..* | Reference(Resource) | Element idCondition.evidence.detail Short description Supporting information found elsewhere Definition Links to other relevant information, including pathology reports.
Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data type Reference(Resource) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- w5: FiveWs.why[x]
- rim: .self
- pCHDCF: Health Concern Supporting Documents
|
note | | 0..* | Annotation | There are no (further) constraints on this element Element idShort description Additional information about the Condition Definition Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.
Comments For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
Data type Annotation Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: N/A
- rim: Act
- workflow: Event.note
- v2: NTE child of PRB
- rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value
|