QI-Core Implementation Guide
7.0.0 - STU7 United States of America flag

QI-Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 7.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-qi-core/ and changes regularly. See the Directory of published versions

Resource Profile: QICoreProcedureNotDone - Detailed Descriptions

Active as of 2018-08-22

Definitions for the qicore-procedurenotdone resource profile.

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

0. Procedure
Definition

An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.

ShortAn action that is being or was performed on 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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
us-core-7: Performed SHALL be present if the status is 'completed' or 'in-progress' ((status='completed' or status='in-progress') implies performed.exists())
prc-1: to indicate what procedure, either at least one coding in the code or a codeOptions extension shall be provided (code.extension('http://hl7.org/fhir/StructureDefinition/codeOptions').exists() xor code.coding.exists())
2. Procedure.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 it's 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 it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Procedure.extension
Definition

An Extension


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.

ShortExtensionAdditional 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.

Control10..*
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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Procedure.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Procedure.extension:recorded
    Slice Namerecorded
    Definition

    Optional Extension Element - found in all resources.

    Short(QI) When the procedure was first captured in the subject's record
    Control1..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Extension Definition for Procedure.recorded for Version 5.0) (Extension Type: dateTime)
    Is Modifierfalse
    Invariantsele-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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Procedure.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    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
    Summaryfalse
    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()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Procedure.status
    Definition

    A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.

    Short(QI) not-donepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
    Comments

    The "unknown" code is not to be used to convey other statuses. The "unknown" code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the procedure.

    This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

    Control1..1
    This element is affected by the following invariants: us-core-7
    BindingThe codes SHALL be taken from EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/event-status)
    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
    Must Supporttrue
    Summarytrue
    Fixed Valuenot-done
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. Procedure.statusReason
    Definition

    Captures the reason for the current state of the procedure.

    Short(QI) Reason for the current statusReason for current status
    Comments

    This is generally only used for "exception" statuses such as "not-done", "suspended" or "aborted". The reason for performing the event at all is captured in reasonCode, not here.

    Control10..1
    BindingUnless not suitable, these codes SHALL be taken from For example codes, see QICore Negation Reason Codeshttp://hl7.org/fhir/ValueSet/procedure-not-performed-reason
    (extensible to http://hl7.org/fhir/us/qicore/ValueSet/qicore-negation-reason)

    The reason the procedure was not done


    A code that identifies the reason a procedure was not performed.

    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Alternate NamesSuspended Reason, Cancelled Reason
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Procedure.code
    Definition

    The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").

    Short(QI) What procedureIdentification of the procedure
    Control10..1
    This element is affected by the following invariants: prc-1
    BindingThe codes SHOULD be taken from For example codes, see US Core Procedure Codeshttp://hl7.org/fhir/ValueSet/procedure-code
    (preferred to http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code)

    Codes describing the type of Procedure


    A code to identify a specific procedure .

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    0..1 to account for primarily narrative only resources.

    Alternate Namestype
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Procedure.code.extension:codeOptions
    Slice NamecodeOptions
    Definition

    A logical reference (e.g. a reference to ValueSet.url) to a value set/version that identifies a set of possible coded values representing the procedure.

    Short(QI) Url of a value set of candidate procedures
    Comments

    This extension SHALL NOT be used when an appropriate higher level concept code exists. When this extension is used on an element with a required binding, the set of possible coded values in the referenced value set SHALL be present in the bound value set. When used with an extensible binding, the set of possible coded values in the referenced value set SHALL be present in the bound value set unless none of the codes in the bound value set apply to the concept being communicated (based on human review). When this extension appears on a CodeableConcept, the CodeableConcept SHALL have no codings, and the text of the CodeableConcept SHALL include the title of the referenced value set.

    Control0..1
    This element is affected by the following invariants: prc-1
    TypeExtension(Code Options) (Extension Type: canonical(ValueSet))
    Is Modifierfalse
    Summaryfalse
    Invariantsele-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())
    18. Procedure.subject
    Definition

    The person, animal or group on which the procedure was performed.

    Short(QI) Who the procedure was performed onWho the procedure was performed on
    Control1..1
    TypeReference(QICore Patient, Patient, Group)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Alternate Namespatient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. Procedure.encounter
    Definition

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

    ShortEncounter associated with the procedureEncounter created as part of
    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(US Core Encounter Profile, Encounter)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Procedure.performed[x]
    Definition

    Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

    Short(QI) When the procedure was performedWhen the procedure was performed
    Comments

    Age is generally used when the patient reports an age at which the procedure was performed. Range is generally used when the patient reports an age range when the procedure was performed, such as sometime between 20-25 years old. dateTime supports a range of precision due to some procedures being reported as past procedures that might not have millisecond precision while other procedures performed and documented during the encounter might have more precise UTC timestamps with timezone.

    Control0..1
    This element is affected by the following invariants: us-core-7
    TypeChoice of: dateTime, Period, string, Age, Range
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Must Support TypesdateTime
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))