FHIR R6 Patient Care Incubator
0.1.0 - ci-build International flag

FHIR R6 Patient Care Incubator, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/pc-incubator/ and changes regularly. See the Directory of published versions

Resource Profile: ClinicalAssessment - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 1

Definitions for the ClinicalAssessment resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. ClinicalAssessment
Definition

A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow.


A resource that includes narrative, extensions, and contained resources.

ShortA clinical assessment performed when planning treatments and management strategies for a patientA resource with narrative, extensions, and contained resources
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').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. ClinicalAssessment.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. ClinicalAssessment.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.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. ClinicalAssessment.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.

ShortA set of rules under which this content was created
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 its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. ClinicalAssessment.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
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).

Control0..1
BindingThe codes SHALL be taken from AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3
(required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. ClinicalAssessment.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.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a 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.

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. ClinicalAssessment.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline 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. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. ClinicalAssessment.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 managable, 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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on ClinicalAssessment.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 16. ClinicalAssessment.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 managable, 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).

    ShortExtensions that cannot be ignored
    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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Must Supportfalse
    Summarytrue
    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 Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on ClinicalAssessment.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 18. ClinicalAssessment.identifier
      Definition

      Business identifiers assigned to this clinical assessment by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

      ShortBusiness identifier
      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.

      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier
      Summarytrue
      Requirements

      Allows identification of the clinical assessment as it is known by various participating systems and in a way that remains consistent across servers.

      20. ClinicalAssessment.status
      Definition

      Identifies the workflow status of the assessment.

      Shortpreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
      Comments

      This element is labeled as a modifier because the status contains the code entered-in-error that marks the clinical assessment as not currently valid.

      Control1..1
      BindingThe codes SHALL be taken from EventStatushttp://hl7.org/fhir/ValueSet/event-status
      (required to http://hl7.org/fhir/ValueSet/event-status)

      The workflow state of a clinical assessment.

      Typecode
      Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      22. ClinicalAssessment.statusReason
      Definition

      Captures the reason for the current state of the ClinicalAssessment.

      ShortReason for current status
      Comments

      This is generally only used for "exception" statuses such as "not-done", "on-hold" or "stopped".

      Control0..1
      BindingFor example codes, see ClinicalAssessmentStatusReasonhttp://hl7.org/fhir/ValueSet/clinicalassessment-status-reason
      (example to http://hl7.org/fhir/ValueSet/clinicalassessment-status-reason)

      Codes identifying the reason for the current state of a clinical assessment.

      TypeCodeableConcept
      Alternate NamesSuspended Reason, Cancelled Reason
      24. ClinicalAssessment.description
      Definition

      A summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.

      ShortWhy/how the assessment was performed
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      26. ClinicalAssessment.subject
      Definition

      The patient or group of individuals assessed as part of this record.

      ShortPatient or group assessed
      Control1..1
      TypeReference(Patient, Group)
      Summarytrue
      Requirements

      Group is typically for veterinary and/or public health purposes.

      28. ClinicalAssessment.encounter
      Definition

      The Encounter during which this ClinicalAssessment was created or to which the creation of this record is tightly associated.

      ShortThe Encounter during which this ClinicalAssessment was created
      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.

      Control0..1
      TypeReference(Encounter)
      Summarytrue
      30. ClinicalAssessment.effective[x]
      Definition

      The point in time or period over which the subject was assessed.

      ShortTime of assessment
      Comments

      This SHOULD be accurate to at least the minute, though some assessments only have a known date.

      Control0..1
      TypeChoice of: dateTime, Period
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      32. ClinicalAssessment.date
      Definition

      Indicates when the documentation of the assessment was complete.

      ShortWhen the assessment was documented
      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      34. ClinicalAssessment.performer
      Definition

      The clinician performing the assessment.

      ShortThe clinician performing the assessment
      Control0..1
      TypeReference(Practitioner, PractitionerRole)
      Summarytrue
      36. ClinicalAssessment.previous
      Definition

      A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.

      ShortReference to last assessment
      Comments

      It is always likely that multiple previous assessments exist for a patient. The point of quoting a previous assessment is that this assessment is relative to it (see resolved).

      Control0..1
      TypeReference(Clinical assessment)
      38. ClinicalAssessment.problem
      Definition

      A list of the relevant problems/conditions for a patient.

      ShortRelevant assessments of patient state
      Comments

      e.g. The patient is a pregnant, has congestive heart failure, has an Adenocarcinoma, and is allergic to penicillin.

      Control0..*
      TypeReference(Condition, AllergyIntolerance)
      Summarytrue
      40. ClinicalAssessment.changePattern
      Definition

      Change in the status/pattern of a subject's condition since previously assessed, such as worsening, improving, or no change. It is a subjective assessment of the direction of the change.

      ShortChange in the status/pattern of a subject's condition since previously assessed, such as worsening, improving, or no change
      Control0..1
      BindingFor example codes, see ClinicalAssessmentChangePatterhttp://hl7.org/fhir/ValueSet/clinicalassessment-change-pattern
      (example to http://hl7.org/fhir/ValueSet/clinicalassessment-change-pattern)
      TypeCodeableConcept
      42. ClinicalAssessment.protocol
      Definition

      Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.

      ShortClinical Protocol followed
      Control0..*
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      44. ClinicalAssessment.summary
      Definition

      A text summary of the investigations and the diagnosis.

      ShortText summary of the assessment
      Control0..1
      Typemarkdown
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      46. ClinicalAssessment.finding
      Definition

      Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.

      ShortPossible or likely findings and diagnoses
      Control0..*
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
      48. ClinicalAssessment.finding.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      This element is affected by the following invariants: ele-1
      Typeidstring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      50. ClinicalAssessment.finding.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 managable, 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.

      ShortAdditional content defined by implementations
      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.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on ClinicalAssessment.finding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 52. ClinicalAssessment.finding.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 managable, 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).

        ShortExtensions that cannot be ignored even if unrecognized
        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        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 Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        54. ClinicalAssessment.finding.item
        Definition

        Specific text, code or reference for finding or diagnosis, which may include ruled-out or resolved conditions.

        ShortWhat was found
        Control0..1
        BindingFor example codes, see ConditionProblemDiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code
        (example to http://hl7.org/fhir/ValueSet/condition-code)

        Identification of the Condition or diagnosis.

        TypeCodeableReference(Condition, Observation, DocumentReference)
        56. ClinicalAssessment.finding.basis
        Definition

        Which investigations support finding or diagnosis.

        ShortWhich investigations support finding
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        58. ClinicalAssessment.prognosis
        Definition

        Estimate of likely outcome.

        ShortEstimate of likely outcome
        Control0..*
        BindingFor example codes, see ClinicalAssessmentPrognosishttp://hl7.org/fhir/ValueSet/clinicalassessment-prognosis
        (example to http://hl7.org/fhir/ValueSet/clinicalassessment-prognosis)

        Prognosis or outlook findings.

        TypeCodeableReference(RiskAssessment)
        60. ClinicalAssessment.supportingInfo
        Definition

        Information supporting the clinical assessment, which can contain investigation results.

        ShortInformation supporting the clinical assessment
        Control0..*
        TypeReference(Resource)
        62. ClinicalAssessment.note
        Definition

        Commentary about the assessment, typically recorded after the assessment itself was made, though supplemental notes by the original author could also appear.

        ShortComments made about the ClinicalAssessment
        Comments

        Don't use this element for content that should more properly appear as one of the specific elements of the assessment.

        Control0..*
        TypeAnnotation

        Guidance on how to interpret the contents of this table can be foundhere

        0. ClinicalAssessment
        Definition

        A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow.

        ShortA clinical assessment performed when planning treatments and management strategies for a patient
        Control0..*
        2. ClinicalAssessment.identifier
        Definition

        Business identifiers assigned to this clinical assessment by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

        ShortBusiness identifier
        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.

        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        TypeIdentifier
        Requirements

        Allows identification of the clinical assessment as it is known by various participating systems and in a way that remains consistent across servers.

        4. ClinicalAssessment.status
        Definition

        Identifies the workflow status of the assessment.

        Shortpreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
        Comments

        This element is labeled as a modifier because the status contains the code entered-in-error that marks the clinical assessment as not currently valid.

        Control1..1
        BindingThe codes SHALL be taken from EventStatus
        (required to http://hl7.org/fhir/ValueSet/event-status)

        The workflow state of a clinical assessment.

        Typecode
        Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        6. ClinicalAssessment.statusReason
        Definition

        Captures the reason for the current state of the ClinicalAssessment.

        ShortReason for current status
        Comments

        This is generally only used for "exception" statuses such as "not-done", "on-hold" or "stopped".

        Control0..1
        BindingFor example codes, see ClinicalAssessmentStatusReason
        (example to http://hl7.org/fhir/ValueSet/clinicalassessment-status-reason)

        Codes identifying the reason for the current state of a clinical assessment.

        TypeCodeableConcept
        Alternate NamesSuspended Reason, Cancelled Reason
        8. ClinicalAssessment.description
        Definition

        A summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.

        ShortWhy/how the assessment was performed
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        10. ClinicalAssessment.subject
        Definition

        The patient or group of individuals assessed as part of this record.

        ShortPatient or group assessed
        Control1..1
        TypeReference(Patient, Group)
        Requirements

        Group is typically for veterinary and/or public health purposes.

        12. ClinicalAssessment.encounter
        Definition

        The Encounter during which this ClinicalAssessment was created or to which the creation of this record is tightly associated.

        ShortThe Encounter during which this ClinicalAssessment was created
        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.

        Control0..1
        TypeReference(Encounter)
        14. ClinicalAssessment.effective[x]
        Definition

        The point in time or period over which the subject was assessed.

        ShortTime of assessment
        Comments

        This SHOULD be accurate to at least the minute, though some assessments only have a known date.

        Control0..1
        TypeChoice of: dateTime, Period
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        16. ClinicalAssessment.date
        Definition

        Indicates when the documentation of the assessment was complete.

        ShortWhen the assessment was documented
        Control0..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        18. ClinicalAssessment.performer
        Definition

        The clinician performing the assessment.

        ShortThe clinician performing the assessment
        Control0..1
        TypeReference(Practitioner, PractitionerRole)
        20. ClinicalAssessment.previous
        Definition

        A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.

        ShortReference to last assessment
        Comments

        It is always likely that multiple previous assessments exist for a patient. The point of quoting a previous assessment is that this assessment is relative to it (see resolved).

        Control0..1
        TypeReference(Clinical assessment)
        22. ClinicalAssessment.problem
        Definition

        A list of the relevant problems/conditions for a patient.

        ShortRelevant assessments of patient state
        Comments

        e.g. The patient is a pregnant, has congestive heart failure, has an Adenocarcinoma, and is allergic to penicillin.

        Control0..*
        TypeReference(Condition, AllergyIntolerance)
        24. ClinicalAssessment.changePattern
        Definition

        Change in the status/pattern of a subject's condition since previously assessed, such as worsening, improving, or no change. It is a subjective assessment of the direction of the change.

        ShortChange in the status/pattern of a subject's condition since previously assessed, such as worsening, improving, or no change
        Control0..1
        BindingFor example codes, see ClinicalAssessmentChangePatter
        (example to http://hl7.org/fhir/ValueSet/clinicalassessment-change-pattern)
        TypeCodeableConcept
        26. ClinicalAssessment.protocol
        Definition

        Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.

        ShortClinical Protocol followed
        Control0..*
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        28. ClinicalAssessment.summary
        Definition

        A text summary of the investigations and the diagnosis.

        ShortText summary of the assessment
        Control0..1
        Typemarkdown
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        30. ClinicalAssessment.finding
        Definition

        Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.

        ShortPossible or likely findings and diagnoses
        Control0..*
        TypeBackboneElement
        32. ClinicalAssessment.finding.item
        Definition

        Specific text, code or reference for finding or diagnosis, which may include ruled-out or resolved conditions.

        ShortWhat was found
        Control0..1
        BindingFor example codes, see ConditionProblemDiagnosisCodes
        (example to http://hl7.org/fhir/ValueSet/condition-code)

        Identification of the Condition or diagnosis.

        TypeCodeableReference(Condition, Observation, DocumentReference)
        34. ClinicalAssessment.finding.basis
        Definition

        Which investigations support finding or diagnosis.

        ShortWhich investigations support finding
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        36. ClinicalAssessment.prognosis
        Definition

        Estimate of likely outcome.

        ShortEstimate of likely outcome
        Control0..*
        BindingFor example codes, see ClinicalAssessmentPrognosis
        (example to http://hl7.org/fhir/ValueSet/clinicalassessment-prognosis)

        Prognosis or outlook findings.

        TypeCodeableReference(RiskAssessment)
        38. ClinicalAssessment.supportingInfo
        Definition

        Information supporting the clinical assessment, which can contain investigation results.

        ShortInformation supporting the clinical assessment
        Control0..*
        TypeReference(Resource)
        40. ClinicalAssessment.note
        Definition

        Commentary about the assessment, typically recorded after the assessment itself was made, though supplemental notes by the original author could also appear.

        ShortComments made about the ClinicalAssessment
        Comments

        Don't use this element for content that should more properly appear as one of the specific elements of the assessment.

        Control0..*
        TypeAnnotation

        Guidance on how to interpret the contents of this table can be foundhere

        0. ClinicalAssessment
        Definition

        A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow.

        ShortA clinical assessment performed when planning treatments and management strategies for a patient
        Control0..*
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Invariantsdom-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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').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. ClinicalAssessment.id
        Definition

        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

        ShortLogical id of this artifact
        Comments

        Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

        Control0..1
        Typeid
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        4. ClinicalAssessment.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.

        ShortMetadata about the resource
        Control0..1
        TypeMeta
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        6. ClinicalAssessment.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.

        ShortA set of rules under which this content was created
        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 its narrative along with other profiles, value sets, etc.

        Control0..1
        Typeuri
        Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        8. ClinicalAssessment.language
        Definition

        The base language in which the resource is written.

        ShortLanguage of the resource content
        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).

        Control0..1
        BindingThe codes SHALL be taken from AllLanguages
        (required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3)

        IETF language tag for a human language

        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        10. ClinicalAssessment.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.

        ShortText summary of the resource, for human interpretation
        Comments

        Contained resources do not have a 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.

        Control0..1
        This element is affected by the following invariants: dom-6
        TypeNarrative
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Alternate Namesnarrative, html, xhtml, display
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        12. ClinicalAssessment.contained
        Definition

        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

        ShortContained, inline 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. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

        Control0..*
        This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
        TypeResource
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Alternate Namesinline resources, anonymous resources, contained resources
        14. ClinicalAssessment.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 managable, 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.

        ShortAdditional content defined by implementations
        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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on ClinicalAssessment.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 16. ClinicalAssessment.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 managable, 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).

          ShortExtensions that cannot be ignored
          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.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
          Must Supportfalse
          Summarytrue
          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 Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on ClinicalAssessment.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 18. ClinicalAssessment.identifier
            Definition

            Business identifiers assigned to this clinical assessment by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

            ShortBusiness identifier
            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.

            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..*
            TypeIdentifier
            Summarytrue
            Requirements

            Allows identification of the clinical assessment as it is known by various participating systems and in a way that remains consistent across servers.

            20. ClinicalAssessment.status
            Definition

            Identifies the workflow status of the assessment.

            Shortpreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
            Comments

            This element is labeled as a modifier because the status contains the code entered-in-error that marks the clinical assessment as not currently valid.

            Control1..1
            BindingThe codes SHALL be taken from EventStatus
            (required to http://hl7.org/fhir/ValueSet/event-status)

            The workflow state of a clinical assessment.

            Typecode
            Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            22. ClinicalAssessment.statusReason
            Definition

            Captures the reason for the current state of the ClinicalAssessment.

            ShortReason for current status
            Comments

            This is generally only used for "exception" statuses such as "not-done", "on-hold" or "stopped".

            Control0..1
            BindingFor example codes, see ClinicalAssessmentStatusReason
            (example to http://hl7.org/fhir/ValueSet/clinicalassessment-status-reason)

            Codes identifying the reason for the current state of a clinical assessment.

            TypeCodeableConcept
            Alternate NamesSuspended Reason, Cancelled Reason
            24. ClinicalAssessment.description
            Definition

            A summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.

            ShortWhy/how the assessment was performed
            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            26. ClinicalAssessment.subject
            Definition

            The patient or group of individuals assessed as part of this record.

            ShortPatient or group assessed
            Control1..1
            TypeReference(Patient, Group)
            Summarytrue
            Requirements

            Group is typically for veterinary and/or public health purposes.

            28. ClinicalAssessment.encounter
            Definition

            The Encounter during which this ClinicalAssessment was created or to which the creation of this record is tightly associated.

            ShortThe Encounter during which this ClinicalAssessment was created
            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.

            Control0..1
            TypeReference(Encounter)
            Summarytrue
            30. ClinicalAssessment.effective[x]
            Definition

            The point in time or period over which the subject was assessed.

            ShortTime of assessment
            Comments

            This SHOULD be accurate to at least the minute, though some assessments only have a known date.

            Control0..1
            TypeChoice of: dateTime, Period
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            32. ClinicalAssessment.date
            Definition

            Indicates when the documentation of the assessment was complete.

            ShortWhen the assessment was documented
            Control0..1
            TypedateTime
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            34. ClinicalAssessment.performer
            Definition

            The clinician performing the assessment.

            ShortThe clinician performing the assessment
            Control0..1
            TypeReference(Practitioner, PractitionerRole)
            Summarytrue
            36. ClinicalAssessment.previous
            Definition

            A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.

            ShortReference to last assessment
            Comments

            It is always likely that multiple previous assessments exist for a patient. The point of quoting a previous assessment is that this assessment is relative to it (see resolved).

            Control0..1
            TypeReference(Clinical assessment)
            38. ClinicalAssessment.problem
            Definition

            A list of the relevant problems/conditions for a patient.

            ShortRelevant assessments of patient state
            Comments

            e.g. The patient is a pregnant, has congestive heart failure, has an Adenocarcinoma, and is allergic to penicillin.

            Control0..*
            TypeReference(Condition, AllergyIntolerance)
            Summarytrue
            40. ClinicalAssessment.changePattern
            Definition

            Change in the status/pattern of a subject's condition since previously assessed, such as worsening, improving, or no change. It is a subjective assessment of the direction of the change.

            ShortChange in the status/pattern of a subject's condition since previously assessed, such as worsening, improving, or no change
            Control0..1
            BindingFor example codes, see ClinicalAssessmentChangePatter
            (example to http://hl7.org/fhir/ValueSet/clinicalassessment-change-pattern)
            TypeCodeableConcept
            42. ClinicalAssessment.protocol
            Definition

            Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.

            ShortClinical Protocol followed
            Control0..*
            Typeuri
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            44. ClinicalAssessment.summary
            Definition

            A text summary of the investigations and the diagnosis.

            ShortText summary of the assessment
            Control0..1
            Typemarkdown
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            46. ClinicalAssessment.finding
            Definition

            Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.

            ShortPossible or likely findings and diagnoses
            Control0..*
            TypeBackboneElement
            Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
            48. ClinicalAssessment.finding.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            This element is affected by the following invariants: ele-1
            Typeid
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            50. ClinicalAssessment.finding.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 managable, 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.

            ShortAdditional content defined by implementations
            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.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on ClinicalAssessment.finding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 52. ClinicalAssessment.finding.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 managable, 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).

              ShortExtensions that cannot be ignored even if unrecognized
              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.

              Control0..*
              TypeExtension
              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
              Summarytrue
              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 Namesextensions, user content, modifiers
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              54. ClinicalAssessment.finding.item
              Definition

              Specific text, code or reference for finding or diagnosis, which may include ruled-out or resolved conditions.

              ShortWhat was found
              Control0..1
              BindingFor example codes, see ConditionProblemDiagnosisCodes
              (example to http://hl7.org/fhir/ValueSet/condition-code)

              Identification of the Condition or diagnosis.

              TypeCodeableReference(Condition, Observation, DocumentReference)
              56. ClinicalAssessment.finding.basis
              Definition

              Which investigations support finding or diagnosis.

              ShortWhich investigations support finding
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              58. ClinicalAssessment.prognosis
              Definition

              Estimate of likely outcome.

              ShortEstimate of likely outcome
              Control0..*
              BindingFor example codes, see ClinicalAssessmentPrognosis
              (example to http://hl7.org/fhir/ValueSet/clinicalassessment-prognosis)

              Prognosis or outlook findings.

              TypeCodeableReference(RiskAssessment)
              60. ClinicalAssessment.supportingInfo
              Definition

              Information supporting the clinical assessment, which can contain investigation results.

              ShortInformation supporting the clinical assessment
              Control0..*
              TypeReference(Resource)
              62. ClinicalAssessment.note
              Definition

              Commentary about the assessment, typically recorded after the assessment itself was made, though supplemental notes by the original author could also appear.

              ShortComments made about the ClinicalAssessment
              Comments

              Don't use this element for content that should more properly appear as one of the specific elements of the assessment.

              Control0..*
              TypeAnnotation