Da Vinci Health Record Exchange (HRex)
1.0.0 - STU R1 United States of America flag

Da Vinci Health Record Exchange (HRex), published by HL7 International - Clinical Interoperability Council. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/davinci-ehrx/ and changes regularly. See the Directory of published versions

Resource Profile: HRex Task Data Request Profile

Official URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-task-data-request Version: 1.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: HRexTaskDataRequest

This Task profile is used to solicit information from a system when direct query is not possible and human intervention might be required

Several Da Vinci guides have a requirement to asynchronously request data that may involve a human collecting, organizing, and/or reviewing data, as described in Requesting exchange using Task. This profile shows how Da Vinci uses Task to perform that process, including defining ‘standard’ codes for the Task and its associated inputs and outputs.

The Task supports two approaches to data sharing:

  • One involves leveraging the FHIR ‘search’ mechanism, but with the ability for humans to intervene to either refine the filter or to review/prune the result set.
  • The second involves either specifying a code or text that describes the data to be retrieved

The content resulting from the request might be conveyed by reference or contained within the Task - and can be any sort of FHIR resource at all (and, using DocumentReference or Binary, can include non-FHIR content as well).

When a task is complete but yields no information (empty search results), an empty search-set Bundle will be returned. However, if searching is performed by document code, the result will be a ‘failed’ status with a statusReason.text indicating that no matching documents existed.

Other Da Vinci IGs may further refine this profile to further refine the request mechanism and/or to constrain the location or permitted content of the returned data.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Task

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA task to be performed
tdr-1: Must have exactly one input that is data-query or data-code
tdr-2: Task statusReason SHALL be populated if status is 'rejected' or 'failed'
tdr-3: Task output SHALL be populated if status is 'completed'
... basedOn S0..*Reference(Resource)Authorization for data request
... status S1..1codedraft | requested | received | accepted | +
Binding: HRex Task Status ValueSet (required)
... statusReason S0..1CodeableConceptReason for current status
.... text S1..1stringPlain text representation of the concept
.... text S1..1stringPlain text representation of the concept
... intent S1..1codeunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Fixed Value: order
... code S1..1CodeableConceptTask Type
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-request
... focus 0..0
... for S1..1Reference(US Core Patient Profile)Member being queried
... authoredOn S1..1dateTimeTask Creation Date
... requester S1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Who is asking for data
... owner S1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Who is being asked for data
... reasonCode S0..1CodeableConceptWhy task is needed
.... text S1..1stringPlain text representation of the concept
... reasonReference S0..1Reference(Claim | HRex Coverage Profile)Why task is needed
... Slices for input S1..*BackboneElementInformation used to perform task
Slice: Unordered, Open by pattern:type
.... input:query S0..1BackboneElementRequested query
..... type S1..1CodeableConceptLabel for the input
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-query
..... value[x] S1..1stringquery value
.... input:code S0..1BackboneElementRequested data code
..... type S1..1CodeableConceptLabel for the input
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-code
..... value[x] S1..1CodeableConceptquery value
... Slices for output S0..*BackboneElementInformation produced as part of task
Slice: Unordered, Open by pattern:type
.... output:data S0..*BackboneElementRequested data
..... type S1..1CodeableConceptLabel for output
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-value
..... value[x] S1..1Reference()data reference

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Task.statusrequiredHRexTaskStatus

Constraints

IdGradePath(s)DetailsRequirements
tdr-1errorTaskMust have exactly one input that is data-query or data-code
: input.type.where(coding.where(system='http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp' and (code='data-code' or code='data-query')).exists()).count()=1
tdr-2errorTaskTask statusReason SHALL be populated if status is 'rejected' or 'failed'
: (status = 'rejected' or status = 'failed') implies statusReason.exists()
tdr-3errorTaskTask output SHALL be populated if status is 'completed'
: (status = 'completed') implies output.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA task to be performed
tdr-1: Must have exactly one input that is data-query or data-code
tdr-2: Task statusReason SHALL be populated if status is 'rejected' or 'failed'
tdr-3: Task output SHALL be populated if status is 'completed'
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... basedOn SΣ0..*Reference(Resource)Authorization for data request
... statusReason SΣ0..1CodeableConceptReason for current status
Binding: (unbound) (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.

.... text SΣ1..1stringPlain text representation of the concept
... businessStatus SΣ0..1CodeableConceptE.g. 'waiting on internal review'
Binding: (unbound) (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.

.... text SΣ1..1stringPlain text representation of the concept
... intent SΣ1..1codeunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.


Fixed Value: order
... code SΣ1..1CodeableConceptTask Type
Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-request
... for SΣ1..1Reference(US Core Patient Profile)Member being queried
... authoredOn SC1..1dateTimeTask Creation Date
... requester SΣ1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Who is asking for data
... owner SΣ1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Who is being asked for data
... reasonCode S0..1CodeableConceptWhy task is needed
Binding: (unbound) (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.

.... text SΣ1..1stringPlain text representation of the concept
... reasonReference S0..1Reference(Claim | HRex Coverage Profile)Why task is needed
... Slices for input S1..*BackboneElementInformation used to perform task
Slice: Unordered, Open by pattern:type
.... input:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptLabel for the input
Binding: (unbound) (example): 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.

..... value[x] 1..1Content to use in performing the task
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
.... input:query S0..1BackboneElementRequested query
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type S1..1CodeableConceptLabel for the input
Binding: (unbound) (example): 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.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-query
..... value[x] S1..1stringquery value
.... input:code S0..1BackboneElementRequested data code
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type S1..1CodeableConceptLabel for the input
Binding: (unbound) (example): 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.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-code
..... value[x] S1..1CodeableConceptquery value
... Slices for output S0..*BackboneElementInformation produced as part of task
Slice: Unordered, Open by pattern:type
.... output:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptLabel for output
Binding: (unbound) (example): 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.

..... value[x] 1..1Result of output
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
.... output:data S0..*BackboneElementRequested data
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type S1..1CodeableConceptLabel for output
Binding: (unbound) (example): 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.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-value
..... value[x] S1..1Reference()data reference

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Task.statusrequiredHRexTaskStatus
Task.statusReasonexample
Task.businessStatusexample
Task.intentrequiredFixed Value: order
Task.codeexamplePattern: data-request
Task.reasonCodeexample
Task.input.typeexample
Task.input:query.typeexamplePattern: data-query
Task.input:code.typeexamplePattern: data-code
Task.output.typeexample
Task.output:data.typeexamplePattern: data-value

Constraints

IdGradePath(s)DetailsRequirements
tdr-1errorTaskMust have exactly one input that is data-query or data-code
: input.type.where(coding.where(system='http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp' and (code='data-code' or code='data-query')).exists()).count()=1
tdr-2errorTaskTask statusReason SHALL be populated if status is 'rejected' or 'failed'
: (status = 'rejected' or status = 'failed') implies statusReason.exists()
tdr-3errorTaskTask output SHALL be populated if status is 'completed'
: (status = 'completed') implies output.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA task to be performed
tdr-1: Must have exactly one input that is data-query or data-code
tdr-2: Task statusReason SHALL be populated if status is 'rejected' or 'failed'
tdr-3: Task output SHALL be populated if status is 'completed'
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierTask Instance Identifier
... instantiatesCanonical Σ0..1canonical(ActivityDefinition)Formal definition of task
... instantiatesUri Σ0..1uriFormal definition of task
... basedOn SΣ0..*Reference(Resource)Authorization for data request
... groupIdentifier Σ0..1IdentifierRequisition or grouper id
... partOf Σ0..*Reference(Task)Composite task
... status ?!SΣ1..1codedraft | requested | received | accepted | +
Binding: HRex Task Status ValueSet (required)
... statusReason SΣ0..1CodeableConceptReason for current status
Binding: (unbound) (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text SΣ1..1stringPlain text representation of the concept
... businessStatus SΣ0..1CodeableConceptE.g. 'waiting on internal review'
Binding: (unbound) (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text SΣ1..1stringPlain text representation of the concept
... intent SΣ1..1codeunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.


Fixed Value: order
... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): The task's priority.

... code SΣ1..1CodeableConceptTask Type
Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-request
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... description Σ0..1stringHuman-readable explanation of task
... for SΣ1..1Reference(US Core Patient Profile)Member being queried
... encounter Σ0..1Reference(Encounter)Healthcare event during which this task originated
... executionPeriod Σ0..1PeriodStart and end time of execution
... authoredOn SC1..1dateTimeTask Creation Date
... lastModified ΣC0..1dateTimeTask Last Modified Date
... requester SΣ1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Who is asking for data
... performerType 0..*CodeableConceptRequested performer
Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed.


... owner SΣ1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Who is being asked for data
... location Σ0..1Reference(Location)Where task occurs
... reasonCode S0..1CodeableConceptWhy task is needed
Binding: (unbound) (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text SΣ1..1stringPlain text representation of the concept
... reasonReference S0..1Reference(Claim | HRex Coverage Profile)Why task is needed
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... note 0..*AnnotationComments made about the task
... relevantHistory 0..*Reference(Provenance)Key events in history of the Task
... restriction 0..1BackboneElementConstraints on fulfillment tasks
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... repetitions 0..1positiveIntHow many times to repeat
.... period 0..1PeriodWhen fulfillment sought
.... recipient 0..*Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization)For whom is fulfillment sought?
... Slices for input S1..*BackboneElementInformation used to perform task
Slice: Unordered, Open by pattern:type
.... input:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptLabel for the input
Binding: (unbound) (example): 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.

..... value[x] 1..1Content to use in performing the task
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
.... input:query S0..1BackboneElementRequested query
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type S1..1CodeableConceptLabel for the input
Binding: (unbound) (example): 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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-query
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] S1..1stringquery value
.... input:code S0..1BackboneElementRequested data code
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type S1..1CodeableConceptLabel for the input
Binding: (unbound) (example): 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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-code
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] S1..1CodeableConceptquery value
... Slices for output S0..*BackboneElementInformation produced as part of task
Slice: Unordered, Open by pattern:type
.... output:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptLabel for output
Binding: (unbound) (example): 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.

..... value[x] 1..1Result of output
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
.... output:data S0..*BackboneElementRequested data
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type S1..1CodeableConceptLabel for output
Binding: (unbound) (example): 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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-value
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] S1..1Reference()data reference

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Task.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Task.statusrequiredHRexTaskStatus
Task.statusReasonexample
Task.businessStatusexample
Task.intentrequiredFixed Value: order
Task.priorityrequiredRequestPriority
Task.codeexamplePattern: data-request
Task.performerTypepreferredProcedurePerformerRoleCodes
Task.reasonCodeexample
Task.input.typeexample
Task.input:query.typeexamplePattern: data-query
Task.input:code.typeexamplePattern: data-code
Task.output.typeexample
Task.output:data.typeexamplePattern: data-value

This structure is derived from Task

Summary

Mandatory: 6 elements (3 nested mandatory elements)
Must-Support: 26 elements
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Task.input is sliced based on the value of pattern:type
  • The element Task.output is sliced based on the value of pattern:type

Maturity: 2

Differential View

This structure is derived from Task

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA task to be performed
tdr-1: Must have exactly one input that is data-query or data-code
tdr-2: Task statusReason SHALL be populated if status is 'rejected' or 'failed'
tdr-3: Task output SHALL be populated if status is 'completed'
... basedOn S0..*Reference(Resource)Authorization for data request
... status S1..1codedraft | requested | received | accepted | +
Binding: HRex Task Status ValueSet (required)
... statusReason S0..1CodeableConceptReason for current status
.... text S1..1stringPlain text representation of the concept
.... text S1..1stringPlain text representation of the concept
... intent S1..1codeunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Fixed Value: order
... code S1..1CodeableConceptTask Type
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-request
... focus 0..0
... for S1..1Reference(US Core Patient Profile)Member being queried
... authoredOn S1..1dateTimeTask Creation Date
... requester S1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Who is asking for data
... owner S1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Who is being asked for data
... reasonCode S0..1CodeableConceptWhy task is needed
.... text S1..1stringPlain text representation of the concept
... reasonReference S0..1Reference(Claim | HRex Coverage Profile)Why task is needed
... Slices for input S1..*BackboneElementInformation used to perform task
Slice: Unordered, Open by pattern:type
.... input:query S0..1BackboneElementRequested query
..... type S1..1CodeableConceptLabel for the input
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-query
..... value[x] S1..1stringquery value
.... input:code S0..1BackboneElementRequested data code
..... type S1..1CodeableConceptLabel for the input
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-code
..... value[x] S1..1CodeableConceptquery value
... Slices for output S0..*BackboneElementInformation produced as part of task
Slice: Unordered, Open by pattern:type
.... output:data S0..*BackboneElementRequested data
..... type S1..1CodeableConceptLabel for output
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-value
..... value[x] S1..1Reference()data reference

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Task.statusrequiredHRexTaskStatus

Constraints

IdGradePath(s)DetailsRequirements
tdr-1errorTaskMust have exactly one input that is data-query or data-code
: input.type.where(coding.where(system='http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp' and (code='data-code' or code='data-query')).exists()).count()=1
tdr-2errorTaskTask statusReason SHALL be populated if status is 'rejected' or 'failed'
: (status = 'rejected' or status = 'failed') implies statusReason.exists()
tdr-3errorTaskTask output SHALL be populated if status is 'completed'
: (status = 'completed') implies output.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA task to be performed
tdr-1: Must have exactly one input that is data-query or data-code
tdr-2: Task statusReason SHALL be populated if status is 'rejected' or 'failed'
tdr-3: Task output SHALL be populated if status is 'completed'
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... basedOn SΣ0..*Reference(Resource)Authorization for data request
... statusReason SΣ0..1CodeableConceptReason for current status
Binding: (unbound) (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.

.... text SΣ1..1stringPlain text representation of the concept
... businessStatus SΣ0..1CodeableConceptE.g. 'waiting on internal review'
Binding: (unbound) (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.

.... text SΣ1..1stringPlain text representation of the concept
... intent SΣ1..1codeunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.


Fixed Value: order
... code SΣ1..1CodeableConceptTask Type
Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: data-request
... for SΣ1..1Reference(US Core Patient Profile)Member being queried
... authoredOn SC1..1dateTimeTask Creation Date
... requester SΣ1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Who is asking for data
... owner SΣ1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Who is being asked for data
... reasonCode S0..1CodeableConceptWhy task is needed
Binding: (unbound) (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.

.... text SΣ1..1stringPlain text representation of the concept
... reasonReference S0..1Reference(Claim | HRex Coverage Profile)Why task is needed
... Slices for input S1..*BackboneElementInformation used to perform task
Slice: Unordered, Open by pattern:type
.... input:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptLabel for the input
Binding: (unbound) (example): 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.

..... value[x] 1..1Content to use in performing the task
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
..