Generated Narrative: StructureDefinition cdex-task-attachment-request Name Flags Card. Type Description & Constraints Task <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( cdex-1, cdex-4, cdex-5, cdex-6, cdex-10, tdr-2 )">C 0..* Task A task to be performed Constraints: cdex-1, cdex-4, cdex-5, cdex-6, cdex-10, tdr-2 #xD; Slices for contained S 2..* Resource Contained, inline Resources Slice: Unordered, Open by type:$this #xD; contained:practitionerrole S 1..1 CDexPractitionerRole Contained PractitionerRole resource #xD; contained:patient S 1..1 CDexPatientDemographics Contained Patient resource #xD; Slices for identifier S 1..* Identifier Task Instance Identifier Slice: Unordered, Open by value:$this #xD; identifier:TrackingId S 1..1 Identifier Re-association tracking control number Required Pattern: At least the following #xD; type 1..1 CodeableConcept Description of identifier Fixed Value: (Complex) #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-cdex/CodeSystem/cdex-temp #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: tracking-id #xD; system S 0..1 uri The namespace for the identifier value #xD; value S 1..1 string The value that is unique #xD; identifier:AdminRefNumber S 0..1 Identifier Administrative reference number Required Pattern: At least the following #xD; type 1..1 CodeableConcept Description of identifier Fixed Value: (Complex) #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-cdex/CodeSystem/cdex-temp #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: admin-ref-number #xD; system S 0..1 uri The namespace for the identifier value #xD; value S 1..1 string The value that is unique #xD; status S<a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( cdex-10, tdr-2 )">C 1..1 code draft | requested | received | accepted | + Binding: HRex Task Status ValueSet (required) #xD; statusReason SC 0..1 CodeableConcept Reason for current status #xD; text S 1..1 string Plain text representation of the concept #xD; intent S 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order #xD; code S<a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( cdex-4, cdex-5, cdex-10 )">C 1..1 CodeableConcept attachment-request-code | attachment-request-questionnaire Binding: PAS Task Codes (required) #xD; coding S 1..* Coding Code defined by a terminology system #xD; system S 0..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pas/CodeSystem/PASTempCodes #xD; code S 1..1 code Symbol in syntax defined by the system #xD; for S 1..1 Reference(CDex Patient Demographics Profile) {c} Contained Patient. #xD; reference S 1..1 string Contained resource reference Fixed Value: #patient #xD; requester S 1..1 Reference(HRex Organization Profile(1.1.0)) Payer asking for attachments #xD; identifier S 1..1 Identifier Payer ID #xD; owner S 1..1 Reference(CDex PractitionerRole Profile) {c} Provider who submitted claim or preauthorization #xD; reference S 1..1 string Contained resource reference Fixed Value: #practitionerrole #xD; reasonCode S 1..1 CodeableConcept Why task is needed #xD; Slices for coding S<a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; font-style: italic; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; font-style: italic" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( cdex-1 )">C 1..* Coding Code defined by a terminology system Slice: Unordered, Open by value:$this #xD; coding:use S 1..* Coding Code defined by a terminology system Binding: CDex Claim Use Value Set (required) #xD; system S 0..1 uri Identity of the terminology system #xD; code S 1..1 code claim | preauthorization #xD; text S 0..1 string claim | preauthorization Binding: CDex Claim Use Value Set (required) #xD; reasonReference S 1..1 Reference(Resource) Why task is needed #xD; identifier S 1..1 Identifier Claim or prior authorization ID #xD; restriction S 0..1 BackboneElement Constraints on fulfillment tasks #xD; period S 0..1 Period Attachments due date #xD; Slices for input S 2..* BackboneElement Information used to perform task Slice: Unordered, Open by value:type #xD; input:AttachmentsNeeded S<a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( cdex-4, cdex-6 )">C 0..* BackboneElement Attachment Code Binding: CDex LOINC Attachment Codes Value Set (extensible) Additional Bindings Purpose Usage Any CDex PWK01 Attachment Report Type Code Value Set Extensible usage-context-type workflow: workflow = A payer request for additional information from the provider to support a prior authorization request any repeat All repeats #xD; extension S 0..* Extension Extension #xD; url S 1..1 uri "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-paLineNumber" #xD; value[x] S 1..1 integer Value of extension #xD; type S 1..1 CodeableConcept Label for the input Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pas/CodeSystem/PASTempCodes #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: attachments-needed #xD; value[x] S 1..1 CodeableConcept Attachment code value #xD; input:QuestionnaireContext <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( cdex-5, cdex-6 )">C 0..* BackboneElement Data Request questionnaire #xD; extension S 0..* Extension Extension #xD; url S 1..1 uri "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-paLineNumber" #xD; value[x] S 1..1 integer Value of extension #xD; type 1..1 CodeableConcept Label for the input Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pas/CodeSystem/PASTempCodes #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: questionnaire-context #xD; value[x] 1..1 canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form) URL #xD; Slices for extension Content/Rules for all slices #xD; extension:questionnaireDisplay 0..1 string Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display #xD; input:PayerUrl S 1..1 BackboneElement Payer Url #xD; type S 1..1 CodeableConcept Label for the input Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pas/CodeSystem/PASTempCodes #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: payer-url #xD; value[x] S 1..1 url Payer url value #xD; input:ServiceDate SC 0..1 BackboneElement Service Date #xD; type S 1..1 CodeableConcept Label for the input Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-cdex/CodeSystem/cdex-temp #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: service-date #xD; value[x] SC 1..1 date Service Date value Constraints: cdex-2 #xD; input:Signature S 0..1 BackboneElement Signature flag #xD; type S 1..1 CodeableConcept Label for the input Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-cdex/CodeSystem/cdex-temp #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: signature-flag #xD; value[x] S 1..1 boolean Signature flag value #xD; input:POU 0..1 BackboneElement Purpose of use code' #xD; type 1..1 CodeableConcept Label for the input Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-cdex/CodeSystem/cdex-temp #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: purpose-of-use #xD; value[x] 1..1 CodeableConcept Purpose of use value Binding: CDex Purpose of Use Value Set (extensible) #xD; input:MultipleSubmits 0..1 BackboneElement Multiple submits flag #xD; type 1..1 CodeableConcept Label for the input Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-cdex/CodeSystem/cdex-temp #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: multiple-submits-flag #xD; value[x] 1..1 boolean Multiple submits flag value #xD; Slices for output 0..* BackboneElement Information produced as part of task Slice: Unordered, Open by value:type #xD; output:AttachmentsNeeded 0..* BackboneElement Requested attachments #xD; type 1..1 CodeableConcept Label for output Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pas/CodeSystem/PASTempCodes #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: attachments-needed #xD; value[x] 1..1 Reference() AttachmentsNeeded reference #xD; output:QuestionnaireContext C 0..1 BackboneElement Information produced as part of task #xD; type 1..1 CodeableConcept Label for output Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pas/CodeSystem/PASTempCodes #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: questionnaire-context #xD; value[x] 1..1 Reference(CDex SDC QuestionnaireResponse Profile | Adaptive Questionnaire Response) Reference to the QuestionnaireResponse #xD; Documentation for this format
HL7 International / Payer/Provider Information Exchange Work Group
Payers use this [Task](http://hl7.org/StructureDefinition/Task) based profile to request additional documentation ("attachments") for claims or prior authorizations. It constrains the Task resource to minimal necessary data elements needed to request attachments and respond in a way that is compatible with existing X12 277 RFAI and 278 response transactions to allow for association and requests for (typically PDF and CCDA) documents using LOINC and X12 standard codes. It also supports requests for more detailed missing data using Questionnaire, CQL, and QuestionnaireResponse, as supported by [Da Vinci Documentation Templates and Rules (DTR)](http://hl7.org/fhir/us/davinci-dtr/index.html).
Used by permission of HL7 International all rights reserved Creative Commons License
This Task profile is used to request additional documentation ("attachments") for claims or prior authorizations.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
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()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
Last modified date must be greater than or equal to authored-on date.
lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
not(exists(f:lastModified/@value)) or not(exists(f:authoredOn/@value)) or f:lastModified/@value >= f:authoredOn/@value
The "ServiceDate" input SHALL be present if the attachment is for a claim.
Task.reasonCode.coding.code.where($this='claim').exists() implies Task.input.type.coding.code.where($this='service-date').exists()
If code = "attachment-request-code", must have one or more "AttachmentsNeeded" inputs.
Task.code.coding.code.where($this='attachment-request-code').exists() implies Task.input.type.coding.code.where($this='attachments-needed').exists()
If code = "attachment-request-questionnaire", must have one or more "QuestionnaireContext" inputs.
Task.code.coding.code.where($this='attachment-request-questionnaire').exists() implies Task.input.type.coding.code.where($this='questionnaire-context').exists()
Must have only "AttachmentsNeeded" or "QuestionnaireContext" inputs not both.
Task.input.type.coding.code.where($this='attachments-needed').exists() implies Task.input.type.coding.code.where($this='questionnaire-context').empty()
If code = "attachment-request-questionnaire" and status = "completed", should have one or more "questionnaire-context" outputs referencing the QuestionnaireResponse.
(Task.code.coding.code.where($this='attachment-request-questionnaire').exists() and Task.status.where($this='completed').exists()) implies Task.output.type.coding.code.where($this='questionnaire-context').exists()
Task statusReason SHALL be populated if status is 'rejected' or 'failed'
(status = 'rejected' or status = 'failed') implies statusReason.exists()
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
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.
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.
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
The base language in which the resource is written.
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).
Text summary of the resource, for human interpretation
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.
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.
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.
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.
The contained practitionerrole profile communicates the provider ID as either a unique organization/location identifier (e.g., Type 2 NPI) or unique provider identifier (e.g., Type 1 NPI) or both.
The contained patient profile represents the patient data elements used to verify patient identity.
Additional content defined by implementations
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.
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.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
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).
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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
A Payer-assigned business identifier that ties the attachment(s) back to the claim or prior authorization. This value referred to as the “re-association tracking control numbers” or "attachment control number (ACN)".
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
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.
usual | official | temp | secondary | old (If known)
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Identifies the purpose for this identifier, if known .
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Allows users to make use of identifiers when the identifier system is not known.
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Identifier.system is always case sensitive.
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
Time period when id is/was valid for use
Time period during which identifier is/was valid for use.
Role.effectiveTime or implied by context
Organization that issued id (may be just text)
Organization that issued/manages the identifier.
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
A secondary Payer-assigned business identifier that ties the attachment(s) back to the claim or prior authorization. This value is referred to as the "administrative reference number".
The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
Enables a formal definition of how he task is to be performed, enabling automation.
Request.instantiatesCanonical, Event.instantiatesCanonical
The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
Enables a formal definition of how he task is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation to be associated with a task), enabling automation.
BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.
An identifier that links together multiple tasks and other requests that were created in the same context.
Billing and/or reporting can be linked to whether multiple requests were created as a single unit.
Task that this particular task is part of.
Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task).
draft | requested | received | accepted | +
These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.
This element is labeled 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
An explanation as to why this task is held, failed, was refused, etc.
This applies to the current status. Look at the history of the task to see reasons for past statuses.
Indicates why task failed or was rejected.
Codes to identify the reason for current status. These will typically be specific to a particular workflow.
.inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN, code="status change"].reasonCode
A reference to a code defined by a terminology system.
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Allows for alternative encodings within a code system, and translations to other code systems.
fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Plain text representation of the concept
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Very often the text is the same as a displayName of one of the codings.
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
C*E.9. But note many systems use C*E.2 for this
fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Contains business-specific nuances of the business state.
There's often a need to track substates of a task - this is often variable by specific workflow implementation.
The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.
.inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="business status"]
unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.
This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order".
Distinguishes whether the task is a proposal, plan or full order.
Indicates how quickly the Task should be addressed with respect to other requests.
Used to identify the service level expected while performing a task.
If missing, this task should be performed with normal priority
attachment-request-code | attachment-request-questionnaire
The code element is used to indicate the type of attachment request. The code element is a required element and must be populated with one of the following values: "attachment-request-code" or "attachment-request-questionnaire".
The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code.
The identification of the code system that defines the meaning of the symbol in the code.
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Need to be unambiguous about the source of the definition of the symbol.
fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Need to refer to a particular code in the system.
fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
A representation of the meaning of the code in the system, following the rules of the system.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
C*E.2 - but note this is not well followed
fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
If this coding was chosen directly by the user
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
A free-text description of what is to be performed.
The request being actioned or the resource being manipulated by this task.
If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).
Reference to a contained Patient resource defined by the CDex Patient Demographics Profile. It represents the member who is subject of the claim or preauthorization and demographic data elements that are used by the Provider to verify member identity.
Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control.
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Type the reference refers to (e.g. "Patient")
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Aa resource (or, for logical models, the URI of the logical model).
Logical reference, when literal reference is not known
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Plain text narrative that identifies the resource in addition to the resource reference.
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Healthcare event during which this task originated
The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
For some tasks it may be important to know the link between the encounter the task originated within.
.inboundRelationship[typeCode=COMP].source[classCode=PCPR, moodCode=EVN]
Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).
The date and time this task was created.
Most often used along with lastUpdated to track duration of task to supporting monitoring and management.
The date and time of last modification to this task.
Used along with history to track task activity and time in a particular task state. This enables monitoring and management.
.inboundRelationship[typeCode=SUBJ, ].source[classCode=CACT, moodCode=EVN].effectiveTime
Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task).
Literal reference, Relative, internal or absolute URL
business identifier representing the Payer ID
The kind of participant that should perform the task.
Use to distinguish tasks on different activity queues.
Event.performer.role, Request.performerType
Provider who submitted claim or preauthorization
Individual organization or Device currently responsible for task execution.
The term "Provider" means a person or organization that provided the health care services to a patient.
Identifies who is expected to perform this task.
Event.performer.actor, Request.performer
Principal physical location where the this task is performed.
Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).
A description or code indicating why this task needs to be performed.
This should only be included if there is no focus or if it differs from the reason indicated on the focus.
Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.
A resource reference indicating why this task needs to be performed.
Tasks might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in `Task.reasonCode` if the data is free (uncoded) text.
Request.reasonReference, Event.reasonReference
The business identifier representing the claim or prior authorization ID
Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
Free-text information captured about the task as it progresses.
.inboundRelationship[typeCode=SUBJ, ].source[classCode=OBS, moodCode=EVN, code="annotation"].value(string)
Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.
This element does not point to the Provenance associated with the *current* version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.
.inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]
If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.
Sometimes when fulfillment is sought, you don't want full fulfillment.
Instead of pointing to request, would point to component of request, having these characteristics
Extensions that cannot be ignored even if unrecognized
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).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Indicates the number of times the requested action should occur.
E.g. order that requests monthly lab tests, fulfillment is sought for 1.
Note that period.high is the due date representing the time by which the task should be completed.
E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months.
For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?
Additional information that may be needed in the execution of the task.
Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.
A code or description indicating how the input is intended to be used as part of the task execution.
If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input.
Inputs are named to enable task automation to bind data and pass it from one task to the next.
Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.
The value of the input parameter as a basic type.
A code indicating the type of data/document to be returned
This value set includes LOINC terms that can be sent by a payer as part of an HL7 attachment request for additional documentation. It has been curated by the HL7 Payer/Provider Information Exchange (PIE) Work Group. More information about using LOINC in HIPAA attachments and the source of this value set can be found at https://loinc.org/attachments. For prior authorization, [X12](https://x12.org/) PWK01 Report Type Codes may also be used.
Source of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
Indicates the questionnaire to be completed.
unique id for the element within a resource (for internal references)
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
The title or other name to display when referencing a resource by canonical URL.
This can be handy for commonly used questionnaires with a recognizable name.
The Payer Endpoint URL for submitting attachments using the $submit-attachment operation.
Date of service or starting date of the service for the claim or prior authorization. This element SHALL be present and precise to the day if the attachment is for a claim. It is optional if the attachment is for prior authorization.
Flag to indicate whether the requested data requires a signature.
Represent the purpose of use for the requested data.
Flag to indicate whether the requested data can be submitted in multiple submissions. The default meaning when this input is omitted is multiple-submits = "false" - all the requested data should be submitted in a single transaction.
Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows.
Outputs are named to enable task automation to bind data and pass it from one task to the next.
Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.
The value of the Output parameter as a basic type.
FHIR resource(s) representing the result(s) of the attachments request.
Note that all returned attachments SHOULD comply with appropriate US-Core and/or Da Vinci profiles. The "questionnaire-response" output type is for a QuestionnaireResponse resulting from the request.
Indicates the questionnaire QuestionnaireContext resulting from the request.
In addition to using LOINC attachment codes, a payer may request for additional information from the provider to support a prior authorization request using X12's PWK01 Attachment Report Type Code. Note that the PWK01 codes will not be published in this guide due to X12's IP restrictions.
A payer request for additional information from the provider to support a prior authorization request