This page is part of the SDOH Clinical Care for Multiple Domains (v2.2.0: STU 2.2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForPatient | Version: 2.2.0 | |||
Standards status: Trial-use | Computable Name: SDOHCCTaskForPatient |
Profile for SDOH-related tasks to be carried out by the patient or someone acting on their behalf.
This profile is used to pass a Task authored by a Practitioner or Organization (.requester field) targeting a Patient or Related Person (.owner field) to the individual. These fields are required. The .output is used to return a response appropriate to the requested Task code.
The table shows the types of tasks that can be assigned to the patient and the constraints imposed by each usage that are enforced through invariants:
Task Type | Task.code | Task.description | Task.input | Task.output | Task.focus |
---|---|---|---|---|---|
Questionnaire (FHIR) | complete-questionnaire |
questionnaire, questionnaire-category required | If present, questionnaire-response | ||
Questionnaire (PDF) | complete-questionnaire |
questionnaire-pdf, questionnaire-category required | If present, questionnaire-pdf-completed | ||
Questionnaire (URL) | complete-questionnaire |
questionnaire-url, questionnaire-category required | |||
General Information | general-information |
required | If present, general-information-response | ||
Make Contact Directions | make-contact |
at least one contact-entity is required | If present, chosen-contact | ||
Review Material | review-material |
DocumentReference required. |
See Checking Task Status.
The status values constrain the Task to specific states that are required to support communication with a patient application.
The allowed state transitions are defined graphically in the state diagram below, and are described in the table below.
Code | Display | Definition | Set By |
---|---|---|---|
ready |
Ready | The task is ready to be performed, but no action has been taken. Used in place of requested/received/accepted/rejected when request assignment and acceptance is given | Requester |
in-progress |
In Progress | The task has been started but is not yet complete | Patient App |
completed |
Completed | The task has been completed. | Patient App |
cancelled |
Cancelled | The task was not completed | Requester or Patient App |
on-hold |
On Hold | The task has been started but work has been paused. | Patient App |
failed |
Failed | The task was attempted but could not be completed due to some error. | Patient App |
entered-in-error |
Entered in Error | The task should never have existed and is retained only because of the possibility it may have been used | Requester |
In addition to a limited set of status values, the patient application is only permitted to modify a specific set of elements in responding to the task request. These elements include: .status, .statusReason, and .output. All other elements are outside of the scope of this IG. The patient application cannot modify the status of the referral task SDOHCC Task For Referral Management, that can only be done by the requester and the performing or intermediary entity.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Task
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Task | C | 0..* | Task | A request to fulfill an SDOH questionnaire or service request SDOH-Task-1: If Task.code is “complete-questionnaire”, then exactly one Task.input of either "questionnaire", "questionnaire-pdf", or "questionnaire-url" is required and Task.input "questionnaire-category" is required. SDOH-Task-2: If Task.code is “general-information”, then Task.description is required and Task.output, if present, must be “general-information-response”. SDOH-Task-3: If Task.code is "review-material", then Task.focus of DocumentReference is required. SDOH-Task-4: If Task.code is "make-contact", then Task.input of at least one "contact-entity" is required. SDOH-Task-5: If Task.input is "questionnaire", then Task.output, if present, must be "questionnaire-response". SDOH-Task-6: If Task.input is "questionnaire-pdf", then Task.output, if present, must be "questionnaire-pdf-completed". SDOH-Task-7: If Task.code is "make-contact", then Task.description is required and Task.output, if present, must be "chosen-contact". |
Slices for partOf | 0..* | Reference(Task) | Composite task Slice: Unordered, Open by profile:resolve() | |
partOf:SupportedPartOf | S | 0..* | Reference(SDOHCC Task For Referral Management | SDOHCC Task For Patient) | Composite task |
status | S | 1..1 | code | draft | requested | received | accepted | + Binding: SDOHCC ValueSet Task Status (required) |
statusReason | S | 0..1 | CodeableConcept | Reason for current status |
text | S | 1..1 | string | Plain text representation of the concept |
intent | 1..1 | code | order Fixed Value: order | |
priority | S | 1..1 | code | routine | urgent Binding: SDOHCC ValueSet Task Priority (required) |
code | S | 1..1 | CodeableConcept | Task Type Binding: SDOHCC ValueSet Task Code (extensible) |
text | S | 0..1 | string | Plain text representation of the concept |
description | SC | 0..1 | string | Human-readable explanation of task |
focus | SC | 0..1 | Reference(Resource) | What task is acting on |
for | S | 1..1 | Reference(US Core Patient Profile) | Beneficiary of the Task |
authoredOn | S | 1..1 | dateTime | Task Creation Date |
requester | S | 1..1 | Reference(US Core PractitionerRole Profile | US Core Organization Profile) | Who is asking for task to be done |
owner | S | 1..1 | Reference(US Core Patient Profile | RelatedPerson) | Responsible individual |
Slices for input | 0..* | BackboneElement | Information used to perform task Slice: Unordered, Open by pattern:type | |
input:Questionnaire | SC | 0..1 | BackboneElement | Information used to perform task |
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. The codes represent types of questionnaires that the patient might be asked to complete. Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire | |
value[x] | 1..1 | canonical(SDCBaseQuestionnaire) | Content to use in performing the task | |
input:QuestionnairePDF | SC | 0..1 | BackboneElement | Information used to perform task |
type | 1..1 | CodeableConcept | Label for the input Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-pdf | |
value[x] | 1..1 | Reference(US Core DocumentReference Profile) | Content to use in performing the task | |
input:QuestionnaireURL | SC | 0..1 | BackboneElement | Information used to perform task |
type | 1..1 | CodeableConcept | Label for the input Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-url | |
value[x] | 1..1 | url | Content to use in performing the task | |
input:QuestionnaireCategory | SC | 0..1 | BackboneElement | Information used to perform task |
type | 1..1 | CodeableConcept | Label for the input Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-category | |
value[x] | 1..1 | CodeableConcept | Content to use in performing the task Binding: SDOHCC ValueSet SDOH Questionnaire Category (required): Types of Social Determinant of Health (SDOH) questionnaires that the patient might be asked to complete | |
input:Contact | SC | 0..* | BackboneElement | Information used to perform task |
type | 1..1 | CodeableConcept | Label for the input Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: contact-entity | |
value[x] | 1..1 | Reference(SDOHCC Healthcare Service | US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Organization Profile) | Content to use in performing the task | |
Slices for output | C | 0..* | BackboneElement | Information produced as part of task Slice: Unordered, Open by pattern:type |
output:QuestionnaireResponse | SC | 0..1 | BackboneElement | Information produced as part of task |
type | 1..1 | CodeableConcept | Label for output Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-response | |
value[x] | 1..1 | Reference(SDC Questionnaire Response) | Result of output | |
output:QuestionnairePDFCompleted | SC | 0..1 | BackboneElement | Information produced as part of task |
type | 1..1 | CodeableConcept | Label for output Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-pdf-completed | |
value[x] | 1..1 | Reference(US Core DocumentReference Profile) | Result of output | |
output:GeneralInformationResponse | SC | 0..* | BackboneElement | Information produced as part of task |
type | 1..1 | CodeableConcept | Label for output Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: general-information-response | |
value[x] | 1..1 | markdown | Result of output | |
output:ChosenContact | SC | 0..1 | BackboneElement | Information produced as part of task |
type | 1..1 | CodeableConcept | Label for output Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: chosen-contact | |
value[x] | 1..1 | markdown | Result of output | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Task.status | required | SDOHCCValueSetTaskStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskStatus from this IG | |
Task.priority | required | SDOHCCValueSetTaskPriorityhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskPriority from this IG | |
Task.code | extensible | SDOHCCValueSetTaskCodehttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskCode from this IG | |
Task.input:Questionnaire.type | example | Pattern: questionnaire | |
Task.input:QuestionnaireCategory.value[x] | required | SDOHCCValueSetSDOHQuestionnaireCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHQuestionnaireCategory from this IG |
Id | Grade | Path(s) | Details | Requirements |
SDOH-Task-1 | error | Task | If Task.code is “complete-questionnaire”, then exactly one Task.input of either "questionnaire", "questionnaire-pdf", or "questionnaire-url" is required and Task.input "questionnaire-category" is required. : code.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='complete-questionnaire').exists() implies ((input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire').exists() xor input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-pdf').exists() xor input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-url').exists()) and input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-category').exists()) | |
SDOH-Task-2 | error | Task | If Task.code is “general-information”, then Task.description is required and Task.output, if present, must be “general-information-response”. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='general-information').exists() implies (description.exists() and (output.empty() or output.type.coding.all(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='general-information-response').exists())) | |
SDOH-Task-3 | error | Task | If Task.code is "review-material", then Task.focus of DocumentReference is required. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='review-material').exists() implies focus.resolve().all($this is DocumentReference) | |
SDOH-Task-4 | error | Task | If Task.code is "make-contact", then Task.input of at least one "contact-entity" is required. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='make-contact').exists() implies input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='contact-entity').exists() | |
SDOH-Task-5 | error | Task | If Task.input is "questionnaire", then Task.output, if present, must be "questionnaire-response". : input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire').exists() implies (output.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-response').exists() or output.empty()) | |
SDOH-Task-6 | error | Task | If Task.input is "questionnaire-pdf", then Task.output, if present, must be "questionnaire-pdf-completed". : input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-pdf').exists() implies (output.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-pdf-completed').exists() or output.empty()) | |
SDOH-Task-7 | error | Task | If Task.code is "make-contact", then Task.description is required and Task.output, if present, must be "chosen-contact". : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='make-contact').exists() implies (description.exists() and (output.empty() or output.type.coding.all(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='chosen-contact').exists())) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Task | C | 0..* | Task | A request to fulfill an SDOH questionnaire or service request inv-1: Last modified date must be greater than or equal to authored-on date. SDOH-Task-1: If Task.code is “complete-questionnaire”, then exactly one Task.input of either "questionnaire", "questionnaire-pdf", or "questionnaire-url" is required and Task.input "questionnaire-category" is required. SDOH-Task-2: If Task.code is “general-information”, then Task.description is required and Task.output, if present, must be “general-information-response”. SDOH-Task-3: If Task.code is "review-material", then Task.focus of DocumentReference is required. SDOH-Task-4: If Task.code is "make-contact", then Task.input of at least one "contact-entity" is required. SDOH-Task-5: If Task.input is "questionnaire", then Task.output, if present, must be "questionnaire-response". SDOH-Task-6: If Task.input is "questionnaire-pdf", then Task.output, if present, must be "questionnaire-pdf-completed". SDOH-Task-7: If Task.code is "make-contact", then Task.description is required and Task.output, if present, must be "chosen-contact". |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for partOf | Σ | 0..* | Reference(Task) | Composite task Slice: Unordered, Open by profile:resolve() |
partOf:SupportedPartOf | SΣ | 0..* | Reference(SDOHCC Task For Referral Management | SDOHCC Task For Patient) | Composite task |
status | ?!SΣ | 1..1 | code | draft | requested | received | accepted | + Binding: SDOHCC ValueSet Task Status (required) |
statusReason | SΣ | 0..1 | CodeableConcept | Reason for current status Binding Description (No ValueSet): (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. |
text | SΣ | 1..1 | string | Plain text representation of the concept |
intent | Σ | 1..1 | code | order Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Fixed Value: order |
priority | S | 1..1 | code | routine | urgent Binding: SDOHCC ValueSet Task Priority (required) |
code | SΣ | 1..1 | CodeableConcept | Task Type Binding: SDOHCC ValueSet Task Code (extensible) |
text | SΣ | 0..1 | string | Plain text representation of the concept |
description | SΣC | 0..1 | string | Human-readable explanation of task |
focus | SΣC | 0..1 | Reference(Resource) | What task is acting on |
for | SΣ | 1..1 | Reference(US Core Patient Profile) | Beneficiary of the Task |
authoredOn | SC | 1..1 | dateTime | Task Creation Date |
requester | SΣ | 1..1 | Reference(US Core PractitionerRole Profile | US Core Organization Profile) | Who is asking for task to be done |
owner | SΣ | 1..1 | Reference(US Core Patient Profile | RelatedPerson) | Responsible individual |
Slices for input | 0..* | BackboneElement | Information used to perform task Slice: Unordered, Open by pattern:type | |
input:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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..1 | Content to use in performing the task | ||
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
input:Questionnaire | SC | 0..1 | BackboneElement | Information used to perform task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. The codes represent types of questionnaires that the patient might be asked to complete. Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire | |
value[x] | 1..1 | canonical(SDCBaseQuestionnaire) | Content to use in performing the task | |
input:QuestionnairePDF | SC | 0..1 | BackboneElement | Information used to perform task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-pdf | |
value[x] | 1..1 | Reference(US Core DocumentReference Profile) | Content to use in performing the task | |
input:QuestionnaireURL | SC | 0..1 | BackboneElement | Information used to perform task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-url | |
value[x] | 1..1 | url | Content to use in performing the task | |
input:QuestionnaireCategory | SC | 0..1 | BackboneElement | Information used to perform task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-category | |
value[x] | 1..1 | CodeableConcept | Content to use in performing the task Binding: SDOHCC ValueSet SDOH Questionnaire Category (required): Types of Social Determinant of Health (SDOH) questionnaires that the patient might be asked to complete | |
input:Contact | SC | 0..* | BackboneElement | Information used to perform task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: contact-entity | |
value[x] | 1..1 | Reference(SDOHCC Healthcare Service | US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Organization Profile) | Content to use in performing the task | |
Slices for output | C | 0..* | BackboneElement | Information produced as part of task Slice: Unordered, Open by pattern:type |
output:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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..1 | Result of output | ||
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
output:QuestionnaireResponse | SC | 0..1 | BackboneElement | Information produced as part of task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-response | |
value[x] | 1..1 | Reference(SDC Questionnaire Response) | Result of output | |
output:QuestionnairePDFCompleted | SC | 0..1 | BackboneElement | Information produced as part of task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-pdf-completed | |
value[x] | 1..1 | Reference(US Core DocumentReference Profile) | Result of output | |
output:GeneralInformationResponse | SC | 0..* | BackboneElement | Information produced as part of task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: general-information-response | |
value[x] | 1..1 | markdown | Result of output | |
output:ChosenContact | SC | 0..1 | BackboneElement | Information produced as part of task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: chosen-contact | |
value[x] | 1..1 | markdown | Result of output | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Task.status | required | SDOHCCValueSetTaskStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskStatus from this IG | |
Task.statusReason | example | ||
Task.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1 from the FHIR Standard | |
Task.priority | required | SDOHCCValueSetTaskPriorityhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskPriority from this IG | |
Task.code | extensible | SDOHCCValueSetTaskCodehttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskCode from this IG | |
Task.input.type | example | ||
Task.input:Questionnaire.type | example | Pattern: questionnaire | |
Task.input:QuestionnairePDF.type | example | Pattern: questionnaire-pdf | |
Task.input:QuestionnaireURL.type | example | Pattern: questionnaire-url | |
Task.input:QuestionnaireCategory.type | example | Pattern: questionnaire-category | |
Task.input:QuestionnaireCategory.value[x] | required | SDOHCCValueSetSDOHQuestionnaireCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHQuestionnaireCategory from this IG | |
Task.input:Contact.type | example | Pattern: contact-entity | |
Task.output.type | example | ||
Task.output:QuestionnaireResponse.type | example | Pattern: questionnaire-response | |
Task.output:QuestionnairePDFCompleted.type | example | Pattern: questionnaire-pdf-completed | |
Task.output:GeneralInformationResponse.type | example | Pattern: general-information-response | |
Task.output:ChosenContact.type | example | Pattern: chosen-contact |
Id | Grade | Path(s) | Details | Requirements |
SDOH-Task-1 | error | Task | If Task.code is “complete-questionnaire”, then exactly one Task.input of either "questionnaire", "questionnaire-pdf", or "questionnaire-url" is required and Task.input "questionnaire-category" is required. : code.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='complete-questionnaire').exists() implies ((input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire').exists() xor input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-pdf').exists() xor input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-url').exists()) and input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-category').exists()) | |
SDOH-Task-2 | error | Task | If Task.code is “general-information”, then Task.description is required and Task.output, if present, must be “general-information-response”. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='general-information').exists() implies (description.exists() and (output.empty() or output.type.coding.all(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='general-information-response').exists())) | |
SDOH-Task-3 | error | Task | If Task.code is "review-material", then Task.focus of DocumentReference is required. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='review-material').exists() implies focus.resolve().all($this is DocumentReference) | |
SDOH-Task-4 | error | Task | If Task.code is "make-contact", then Task.input of at least one "contact-entity" is required. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='make-contact').exists() implies input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='contact-entity').exists() | |
SDOH-Task-5 | error | Task | If Task.input is "questionnaire", then Task.output, if present, must be "questionnaire-response". : input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire').exists() implies (output.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-response').exists() or output.empty()) | |
SDOH-Task-6 | error | Task | If Task.input is "questionnaire-pdf", then Task.output, if present, must be "questionnaire-pdf-completed". : input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-pdf').exists() implies (output.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-pdf-completed').exists() or output.empty()) | |
SDOH-Task-7 | error | Task | If Task.code is "make-contact", then Task.description is required and Task.output, if present, must be "chosen-contact". : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='make-contact').exists() implies (description.exists() and (output.empty() or output.type.coding.all(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='chosen-contact').exists())) | |
dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Task | 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 | error | Task | 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 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Task | C | 0..* | Task | A request to fulfill an SDOH questionnaire or service request inv-1: Last modified date must be greater than or equal to authored-on date. SDOH-Task-1: If Task.code is “complete-questionnaire”, then exactly one Task.input of either "questionnaire", "questionnaire-pdf", or "questionnaire-url" is required and Task.input "questionnaire-category" is required. SDOH-Task-2: If Task.code is “general-information”, then Task.description is required and Task.output, if present, must be “general-information-response”. SDOH-Task-3: If Task.code is "review-material", then Task.focus of DocumentReference is required. SDOH-Task-4: If Task.code is "make-contact", then Task.input of at least one "contact-entity" is required. SDOH-Task-5: If Task.input is "questionnaire", then Task.output, if present, must be "questionnaire-response". SDOH-Task-6: If Task.input is "questionnaire-pdf", then Task.output, if present, must be "questionnaire-pdf-completed". SDOH-Task-7: If Task.code is "make-contact", then Task.description is required and Task.output, if present, must be "chosen-contact". | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | Task Instance Identifier | |||||
instantiatesCanonical | Σ | 0..1 | canonical(ActivityDefinition) | Formal definition of task | ||||
instantiatesUri | Σ | 0..1 | uri | Formal definition of task | ||||
basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this task | ||||
groupIdentifier | Σ | 0..1 | Identifier | Requisition or grouper id | ||||
Slices for partOf | Σ | 0..* | Reference(Task) | Composite task Slice: Unordered, Open by profile:resolve() | ||||
partOf:SupportedPartOf | SΣ | 0..* | Reference(SDOHCC Task For Referral Management | SDOHCC Task For Patient) | Composite task | ||||
status | ?!SΣ | 1..1 | code | draft | requested | received | accepted | + Binding: SDOHCC ValueSet Task Status (required) | ||||
statusReason | SΣ | 0..1 | CodeableConcept | Reason for current status Binding Description (No ValueSet): (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | SΣ | 1..1 | string | Plain text representation of the concept | ||||
businessStatus | Σ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding Description (No ValueSet): (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
intent | Σ | 1..1 | code | order Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Fixed Value: order | ||||
priority | S | 1..1 | code | routine | urgent Binding: SDOHCC ValueSet Task Priority (required) | ||||
code | SΣ | 1..1 | CodeableConcept | Task Type Binding: SDOHCC ValueSet Task Code (extensible) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
description | SΣC | 0..1 | string | Human-readable explanation of task | ||||
focus | SΣC | 0..1 | Reference(Resource) | What task is acting on | ||||
for | SΣ | 1..1 | Reference(US Core Patient Profile) | Beneficiary of the Task | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this task originated | ||||
executionPeriod | Σ | 0..1 | Period | Start and end time of execution | ||||
authoredOn | SC | 1..1 | dateTime | Task Creation Date | ||||
lastModified | ΣC | 0..1 | dateTime | Task Last Modified Date | ||||
requester | SΣ | 1..1 | Reference(US Core PractitionerRole Profile | US Core Organization Profile) | Who is asking for task to be done | ||||
performerType | 0..* | CodeableConcept | Requested performer Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed. | |||||
owner | SΣ | 1..1 | Reference(US Core Patient Profile | RelatedPerson) | Responsible individual | ||||
location | Σ | 0..1 | Reference(Location) | Where task occurs | ||||
reasonCode | 0..1 | CodeableConcept | Why task is needed Binding Description (No ValueSet): (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | |||||
reasonReference | 0..1 | Reference(Resource) | Why task is needed | |||||
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
note | 0..* | Annotation | Comments made about the task | |||||
relevantHistory | 0..* | Reference(Provenance) | Key events in history of the Task | |||||
restriction | 0..1 | BackboneElement | Constraints on fulfillment tasks | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
repetitions | 0..1 | positiveInt | How many times to repeat | |||||
period | 0..1 | Period | When fulfillment sought | |||||
recipient | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | |||||
Slices for input | 0..* | BackboneElement | Information used to perform task Slice: Unordered, Open by pattern:type | |||||
input:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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..1 | Content to use in performing the task | ||||||
valueBase64Binary | base64Binary | |||||||
valueBoolean | boolean | |||||||
valueCanonical | canonical(Any) | |||||||
valueCode | code | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
valueId | id | |||||||
valueInstant | instant | |||||||
valueInteger | integer | |||||||
valueMarkdown | markdown | |||||||
valueOid | oid | |||||||
valuePositiveInt | positiveInt | |||||||
valueString | string | |||||||
valueTime | time | |||||||
valueUnsignedInt | unsignedInt | |||||||
valueUri | uri | |||||||
valueUrl | url | |||||||
valueUuid | uuid | |||||||
valueAddress | Address | |||||||
valueAge | Age | |||||||
valueAnnotation | Annotation | |||||||
valueAttachment | Attachment | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueCoding | Coding | |||||||
valueContactPoint | ContactPoint | |||||||
valueCount | Count | |||||||
valueDistance | Distance | |||||||
valueDuration | Duration | |||||||
valueHumanName | HumanName | |||||||
valueIdentifier | Identifier | |||||||
valueMoney | Money | |||||||
valuePeriod | Period | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueReference | Reference(Any) | |||||||
valueSampledData | SampledData | |||||||
valueSignature | Signature | |||||||
valueTiming | Timing | |||||||
valueContactDetail | ContactDetail | |||||||
valueContributor | Contributor | |||||||
valueDataRequirement | DataRequirement | |||||||
valueExpression | Expression | |||||||
valueParameterDefinition | ParameterDefinition | |||||||
valueRelatedArtifact | RelatedArtifact | |||||||
valueTriggerDefinition | TriggerDefinition | |||||||
valueUsageContext | UsageContext | |||||||
valueDosage | Dosage | |||||||
valueMeta | Meta | |||||||
input:Questionnaire | SC | 0..1 | BackboneElement | Information used to perform task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. The codes represent types of questionnaires that the patient might be asked to complete. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | canonical(SDCBaseQuestionnaire) | Content to use in performing the task | |||||
input:QuestionnairePDF | SC | 0..1 | BackboneElement | Information used to perform task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-pdf | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | Reference(US Core DocumentReference Profile) | Content to use in performing the task | |||||
input:QuestionnaireURL | SC | 0..1 | BackboneElement | Information used to perform task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-url | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | url | Content to use in performing the task | |||||
input:QuestionnaireCategory | SC | 0..1 | BackboneElement | Information used to perform task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-category | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | CodeableConcept | Content to use in performing the task Binding: SDOHCC ValueSet SDOH Questionnaire Category (required): Types of Social Determinant of Health (SDOH) questionnaires that the patient might be asked to complete | |||||
input:Contact | SC | 0..* | BackboneElement | Information used to perform task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: contact-entity | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | Reference(SDOHCC Healthcare Service | US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Organization Profile) | Content to use in performing the task | |||||
Slices for output | C | 0..* | BackboneElement | Information produced as part of task Slice: Unordered, Open by pattern:type | ||||
output:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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..1 | Result of output | ||||||
valueBase64Binary | base64Binary | |||||||
valueBoolean | boolean | |||||||
valueCanonical | canonical(Any) | |||||||
valueCode | code | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
valueId | id | |||||||
valueInstant | instant | |||||||
valueInteger | integer | |||||||
valueMarkdown | markdown | |||||||
valueOid | oid | |||||||
valuePositiveInt | positiveInt | |||||||
valueString | string | |||||||
valueTime | time | |||||||
valueUnsignedInt | unsignedInt | |||||||
valueUri | uri | |||||||
valueUrl | url | |||||||
valueUuid | uuid | |||||||
valueAddress | Address | |||||||
valueAge | Age | |||||||
valueAnnotation | Annotation | |||||||
valueAttachment | Attachment | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueCoding | Coding | |||||||
valueContactPoint | ContactPoint | |||||||
valueCount | Count | |||||||
valueDistance | Distance | |||||||
valueDuration | Duration | |||||||
valueHumanName | HumanName | |||||||
valueIdentifier | Identifier | |||||||
valueMoney | Money | |||||||
valuePeriod | Period | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueReference | Reference(Any) | |||||||
valueSampledData | SampledData | |||||||
valueSignature | Signature | |||||||
valueTiming | Timing | |||||||
valueContactDetail | ContactDetail | |||||||
valueContributor | Contributor | |||||||
valueDataRequirement | DataRequirement | |||||||
valueExpression | Expression | |||||||
valueParameterDefinition | ParameterDefinition | |||||||
valueRelatedArtifact | RelatedArtifact | |||||||
valueTriggerDefinition | TriggerDefinition | |||||||
valueUsageContext | UsageContext | |||||||
valueDosage | Dosage | |||||||
valueMeta | Meta | |||||||
output:QuestionnaireResponse | SC | 0..1 | BackboneElement | Information produced as part of task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-response | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | Reference(SDC Questionnaire Response) | Result of output | |||||
output:QuestionnairePDFCompleted | SC | 0..1 | BackboneElement | Information produced as part of task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-pdf-completed | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | Reference(US Core DocumentReference Profile) | Result of output | |||||
output:GeneralInformationResponse | SC | 0..* | BackboneElement | Information produced as part of task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: general-information-response | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | markdown | Result of output | |||||
output:ChosenContact | SC | 0..1 | BackboneElement | Information produced as part of task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: chosen-contact | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | markdown | Result of output | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Task.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Task.status | required | SDOHCCValueSetTaskStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskStatus from this IG | ||||
Task.statusReason | example | |||||
Task.businessStatus | example | |||||
Task.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1 from the FHIR Standard | ||||
Task.priority | required | SDOHCCValueSetTaskPriorityhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskPriority from this IG | ||||
Task.code | extensible | SDOHCCValueSetTaskCodehttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskCode from this IG | ||||
Task.performerType | preferred | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role from the FHIR Standard | ||||
Task.reasonCode | example | |||||
Task.input.type | example | |||||
Task.input:Questionnaire.type | example | Pattern: questionnaire | ||||
Task.input:QuestionnairePDF.type | example | Pattern: questionnaire-pdf | ||||
Task.input:QuestionnaireURL.type | example | Pattern: questionnaire-url | ||||
Task.input:QuestionnaireCategory.type | example | Pattern: questionnaire-category | ||||
Task.input:QuestionnaireCategory.value[x] | required | SDOHCCValueSetSDOHQuestionnaireCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHQuestionnaireCategory from this IG | ||||
Task.input:Contact.type | example | Pattern: contact-entity | ||||
Task.output.type | example | |||||
Task.output:QuestionnaireResponse.type | example | Pattern: questionnaire-response | ||||
Task.output:QuestionnairePDFCompleted.type | example | Pattern: questionnaire-pdf-completed | ||||
Task.output:GeneralInformationResponse.type | example | Pattern: general-information-response | ||||
Task.output:ChosenContact.type | example | Pattern: chosen-contact |
Id | Grade | Path(s) | Details | Requirements |
SDOH-Task-1 | error | Task | If Task.code is “complete-questionnaire”, then exactly one Task.input of either "questionnaire", "questionnaire-pdf", or "questionnaire-url" is required and Task.input "questionnaire-category" is required. : code.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='complete-questionnaire').exists() implies ((input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire').exists() xor input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-pdf').exists() xor input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-url').exists()) and input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-category').exists()) | |
SDOH-Task-2 | error | Task | If Task.code is “general-information”, then Task.description is required and Task.output, if present, must be “general-information-response”. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='general-information').exists() implies (description.exists() and (output.empty() or output.type.coding.all(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='general-information-response').exists())) | |
SDOH-Task-3 | error | Task | If Task.code is "review-material", then Task.focus of DocumentReference is required. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='review-material').exists() implies focus.resolve().all($this is DocumentReference) | |
SDOH-Task-4 | error | Task | If Task.code is "make-contact", then Task.input of at least one "contact-entity" is required. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='make-contact').exists() implies input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='contact-entity').exists() | |
SDOH-Task-5 | error | Task | If Task.input is "questionnaire", then Task.output, if present, must be "questionnaire-response". : input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire').exists() implies (output.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-response').exists() or output.empty()) | |
SDOH-Task-6 | error | Task | If Task.input is "questionnaire-pdf", then Task.output, if present, must be "questionnaire-pdf-completed". : input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-pdf').exists() implies (output.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-pdf-completed').exists() or output.empty()) | |
SDOH-Task-7 | error | Task | If Task.code is "make-contact", then Task.description is required and Task.output, if present, must be "chosen-contact". : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='make-contact').exists() implies (description.exists() and (output.empty() or output.type.coding.all(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='chosen-contact').exists())) | |
dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Task | 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 | error | Task | 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 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn |
This structure is derived from Task
Summary
Mandatory: 6 elements(1 nested mandatory element)
Must-Support: 22 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Task
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Task | C | 0..* | Task | A request to fulfill an SDOH questionnaire or service request SDOH-Task-1: If Task.code is “complete-questionnaire”, then exactly one Task.input of either "questionnaire", "questionnaire-pdf", or "questionnaire-url" is required and Task.input "questionnaire-category" is required. SDOH-Task-2: If Task.code is “general-information”, then Task.description is required and Task.output, if present, must be “general-information-response”. SDOH-Task-3: If Task.code is "review-material", then Task.focus of DocumentReference is required. SDOH-Task-4: If Task.code is "make-contact", then Task.input of at least one "contact-entity" is required. SDOH-Task-5: If Task.input is "questionnaire", then Task.output, if present, must be "questionnaire-response". SDOH-Task-6: If Task.input is "questionnaire-pdf", then Task.output, if present, must be "questionnaire-pdf-completed". SDOH-Task-7: If Task.code is "make-contact", then Task.description is required and Task.output, if present, must be "chosen-contact". |
Slices for partOf | 0..* | Reference(Task) | Composite task Slice: Unordered, Open by profile:resolve() | |
partOf:SupportedPartOf | S | 0..* | Reference(SDOHCC Task For Referral Management | SDOHCC Task For Patient) | Composite task |
status | S | 1..1 | code | draft | requested | received | accepted | + Binding: SDOHCC ValueSet Task Status (required) |
statusReason | S | 0..1 | CodeableConcept | Reason for current status |
text | S | 1..1 | string | Plain text representation of the concept |
intent | 1..1 | code | order Fixed Value: order | |
priority | S | 1..1 | code | routine | urgent Binding: SDOHCC ValueSet Task Priority (required) |
code | S | 1..1 | CodeableConcept | Task Type Binding: SDOHCC ValueSet Task Code (extensible) |
text | S | 0..1 | string | Plain text representation of the concept |
description | SC | 0..1 | string | Human-readable explanation of task |
focus | SC | 0..1 | Reference(Resource) | What task is acting on |
for | S | 1..1 | Reference(US Core Patient Profile) | Beneficiary of the Task |
authoredOn | S | 1..1 | dateTime | Task Creation Date |
requester | S | 1..1 | Reference(US Core PractitionerRole Profile | US Core Organization Profile) | Who is asking for task to be done |
owner | S | 1..1 | Reference(US Core Patient Profile | RelatedPerson) | Responsible individual |
Slices for input | 0..* | BackboneElement | Information used to perform task Slice: Unordered, Open by pattern:type | |
input:Questionnaire | SC | 0..1 | BackboneElement | Information used to perform task |
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. The codes represent types of questionnaires that the patient might be asked to complete. Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire | |
value[x] | 1..1 | canonical(SDCBaseQuestionnaire) | Content to use in performing the task | |
input:QuestionnairePDF | SC | 0..1 | BackboneElement | Information used to perform task |
type | 1..1 | CodeableConcept | Label for the input Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-pdf | |
value[x] | 1..1 | Reference(US Core DocumentReference Profile) | Content to use in performing the task | |
input:QuestionnaireURL | SC | 0..1 | BackboneElement | Information used to perform task |
type | 1..1 | CodeableConcept | Label for the input Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-url | |
value[x] | 1..1 | url | Content to use in performing the task | |
input:QuestionnaireCategory | SC | 0..1 | BackboneElement | Information used to perform task |
type | 1..1 | CodeableConcept | Label for the input Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-category | |
value[x] | 1..1 | CodeableConcept | Content to use in performing the task Binding: SDOHCC ValueSet SDOH Questionnaire Category (required): Types of Social Determinant of Health (SDOH) questionnaires that the patient might be asked to complete | |
input:Contact | SC | 0..* | BackboneElement | Information used to perform task |
type | 1..1 | CodeableConcept | Label for the input Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: contact-entity | |
value[x] | 1..1 | Reference(SDOHCC Healthcare Service | US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Organization Profile) | Content to use in performing the task | |
Slices for output | C | 0..* | BackboneElement | Information produced as part of task Slice: Unordered, Open by pattern:type |
output:QuestionnaireResponse | SC | 0..1 | BackboneElement | Information produced as part of task |
type | 1..1 | CodeableConcept | Label for output Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-response | |
value[x] | 1..1 | Reference(SDC Questionnaire Response) | Result of output | |
output:QuestionnairePDFCompleted | SC | 0..1 | BackboneElement | Information produced as part of task |
type | 1..1 | CodeableConcept | Label for output Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-pdf-completed | |
value[x] | 1..1 | Reference(US Core DocumentReference Profile) | Result of output | |
output:GeneralInformationResponse | SC | 0..* | BackboneElement | Information produced as part of task |
type | 1..1 | CodeableConcept | Label for output Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: general-information-response | |
value[x] | 1..1 | markdown | Result of output | |
output:ChosenContact | SC | 0..1 | BackboneElement | Information produced as part of task |
type | 1..1 | CodeableConcept | Label for output Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: chosen-contact | |
value[x] | 1..1 | markdown | Result of output | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Task.status | required | SDOHCCValueSetTaskStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskStatus from this IG | |
Task.priority | required | SDOHCCValueSetTaskPriorityhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskPriority from this IG | |
Task.code | extensible | SDOHCCValueSetTaskCodehttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskCode from this IG | |
Task.input:Questionnaire.type | example | Pattern: questionnaire | |
Task.input:QuestionnaireCategory.value[x] | required | SDOHCCValueSetSDOHQuestionnaireCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHQuestionnaireCategory from this IG |
Id | Grade | Path(s) | Details | Requirements |
SDOH-Task-1 | error | Task | If Task.code is “complete-questionnaire”, then exactly one Task.input of either "questionnaire", "questionnaire-pdf", or "questionnaire-url" is required and Task.input "questionnaire-category" is required. : code.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='complete-questionnaire').exists() implies ((input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire').exists() xor input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-pdf').exists() xor input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-url').exists()) and input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-category').exists()) | |
SDOH-Task-2 | error | Task | If Task.code is “general-information”, then Task.description is required and Task.output, if present, must be “general-information-response”. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='general-information').exists() implies (description.exists() and (output.empty() or output.type.coding.all(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='general-information-response').exists())) | |
SDOH-Task-3 | error | Task | If Task.code is "review-material", then Task.focus of DocumentReference is required. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='review-material').exists() implies focus.resolve().all($this is DocumentReference) | |
SDOH-Task-4 | error | Task | If Task.code is "make-contact", then Task.input of at least one "contact-entity" is required. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='make-contact').exists() implies input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='contact-entity').exists() | |
SDOH-Task-5 | error | Task | If Task.input is "questionnaire", then Task.output, if present, must be "questionnaire-response". : input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire').exists() implies (output.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-response').exists() or output.empty()) | |
SDOH-Task-6 | error | Task | If Task.input is "questionnaire-pdf", then Task.output, if present, must be "questionnaire-pdf-completed". : input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-pdf').exists() implies (output.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-pdf-completed').exists() or output.empty()) | |
SDOH-Task-7 | error | Task | If Task.code is "make-contact", then Task.description is required and Task.output, if present, must be "chosen-contact". : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='make-contact').exists() implies (description.exists() and (output.empty() or output.type.coding.all(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='chosen-contact').exists())) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Task | C | 0..* | Task | A request to fulfill an SDOH questionnaire or service request inv-1: Last modified date must be greater than or equal to authored-on date. SDOH-Task-1: If Task.code is “complete-questionnaire”, then exactly one Task.input of either "questionnaire", "questionnaire-pdf", or "questionnaire-url" is required and Task.input "questionnaire-category" is required. SDOH-Task-2: If Task.code is “general-information”, then Task.description is required and Task.output, if present, must be “general-information-response”. SDOH-Task-3: If Task.code is "review-material", then Task.focus of DocumentReference is required. SDOH-Task-4: If Task.code is "make-contact", then Task.input of at least one "contact-entity" is required. SDOH-Task-5: If Task.input is "questionnaire", then Task.output, if present, must be "questionnaire-response". SDOH-Task-6: If Task.input is "questionnaire-pdf", then Task.output, if present, must be "questionnaire-pdf-completed". SDOH-Task-7: If Task.code is "make-contact", then Task.description is required and Task.output, if present, must be "chosen-contact". |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for partOf | Σ | 0..* | Reference(Task) | Composite task Slice: Unordered, Open by profile:resolve() |
partOf:SupportedPartOf | SΣ | 0..* | Reference(SDOHCC Task For Referral Management | SDOHCC Task For Patient) | Composite task |
status | ?!SΣ | 1..1 | code | draft | requested | received | accepted | + Binding: SDOHCC ValueSet Task Status (required) |
statusReason | SΣ | 0..1 | CodeableConcept | Reason for current status Binding Description (No ValueSet): (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. |
text | SΣ | 1..1 | string | Plain text representation of the concept |
intent | Σ | 1..1 | code | order Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Fixed Value: order |
priority | S | 1..1 | code | routine | urgent Binding: SDOHCC ValueSet Task Priority (required) |
code | SΣ | 1..1 | CodeableConcept | Task Type Binding: SDOHCC ValueSet Task Code (extensible) |
text | SΣ | 0..1 | string | Plain text representation of the concept |
description | SΣC | 0..1 | string | Human-readable explanation of task |
focus | SΣC | 0..1 | Reference(Resource) | What task is acting on |
for | SΣ | 1..1 | Reference(US Core Patient Profile) | Beneficiary of the Task |
authoredOn | SC | 1..1 | dateTime | Task Creation Date |
requester | SΣ | 1..1 | Reference(US Core PractitionerRole Profile | US Core Organization Profile) | Who is asking for task to be done |
owner | SΣ | 1..1 | Reference(US Core Patient Profile | RelatedPerson) | Responsible individual |
Slices for input | 0..* | BackboneElement | Information used to perform task Slice: Unordered, Open by pattern:type | |
input:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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..1 | Content to use in performing the task | ||
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
input:Questionnaire | SC | 0..1 | BackboneElement | Information used to perform task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. The codes represent types of questionnaires that the patient might be asked to complete. Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire | |
value[x] | 1..1 | canonical(SDCBaseQuestionnaire) | Content to use in performing the task | |
input:QuestionnairePDF | SC | 0..1 | BackboneElement | Information used to perform task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-pdf | |
value[x] | 1..1 | Reference(US Core DocumentReference Profile) | Content to use in performing the task | |
input:QuestionnaireURL | SC | 0..1 | BackboneElement | Information used to perform task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-url | |
value[x] | 1..1 | url | Content to use in performing the task | |
input:QuestionnaireCategory | SC | 0..1 | BackboneElement | Information used to perform task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-category | |
value[x] | 1..1 | CodeableConcept | Content to use in performing the task Binding: SDOHCC ValueSet SDOH Questionnaire Category (required): Types of Social Determinant of Health (SDOH) questionnaires that the patient might be asked to complete | |
input:Contact | SC | 0..* | BackboneElement | Information used to perform task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: contact-entity | |
value[x] | 1..1 | Reference(SDOHCC Healthcare Service | US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Organization Profile) | Content to use in performing the task | |
Slices for output | C | 0..* | BackboneElement | Information produced as part of task Slice: Unordered, Open by pattern:type |
output:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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..1 | Result of output | ||
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
output:QuestionnaireResponse | SC | 0..1 | BackboneElement | Information produced as part of task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-response | |
value[x] | 1..1 | Reference(SDC Questionnaire Response) | Result of output | |
output:QuestionnairePDFCompleted | SC | 0..1 | BackboneElement | Information produced as part of task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-pdf-completed | |
value[x] | 1..1 | Reference(US Core DocumentReference Profile) | Result of output | |
output:GeneralInformationResponse | SC | 0..* | BackboneElement | Information produced as part of task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: general-information-response | |
value[x] | 1..1 | markdown | Result of output | |
output:ChosenContact | SC | 0..1 | BackboneElement | Information produced as part of task |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: chosen-contact | |
value[x] | 1..1 | markdown | Result of output | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Task.status | required | SDOHCCValueSetTaskStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskStatus from this IG | |
Task.statusReason | example | ||
Task.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1 from the FHIR Standard | |
Task.priority | required | SDOHCCValueSetTaskPriorityhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskPriority from this IG | |
Task.code | extensible | SDOHCCValueSetTaskCodehttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskCode from this IG | |
Task.input.type | example | ||
Task.input:Questionnaire.type | example | Pattern: questionnaire | |
Task.input:QuestionnairePDF.type | example | Pattern: questionnaire-pdf | |
Task.input:QuestionnaireURL.type | example | Pattern: questionnaire-url | |
Task.input:QuestionnaireCategory.type | example | Pattern: questionnaire-category | |
Task.input:QuestionnaireCategory.value[x] | required | SDOHCCValueSetSDOHQuestionnaireCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHQuestionnaireCategory from this IG | |
Task.input:Contact.type | example | Pattern: contact-entity | |
Task.output.type | example | ||
Task.output:QuestionnaireResponse.type | example | Pattern: questionnaire-response | |
Task.output:QuestionnairePDFCompleted.type | example | Pattern: questionnaire-pdf-completed | |
Task.output:GeneralInformationResponse.type | example | Pattern: general-information-response | |
Task.output:ChosenContact.type | example | Pattern: chosen-contact |
Id | Grade | Path(s) | Details | Requirements |
SDOH-Task-1 | error | Task | If Task.code is “complete-questionnaire”, then exactly one Task.input of either "questionnaire", "questionnaire-pdf", or "questionnaire-url" is required and Task.input "questionnaire-category" is required. : code.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='complete-questionnaire').exists() implies ((input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire').exists() xor input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-pdf').exists() xor input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-url').exists()) and input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-category').exists()) | |
SDOH-Task-2 | error | Task | If Task.code is “general-information”, then Task.description is required and Task.output, if present, must be “general-information-response”. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='general-information').exists() implies (description.exists() and (output.empty() or output.type.coding.all(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='general-information-response').exists())) | |
SDOH-Task-3 | error | Task | If Task.code is "review-material", then Task.focus of DocumentReference is required. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='review-material').exists() implies focus.resolve().all($this is DocumentReference) | |
SDOH-Task-4 | error | Task | If Task.code is "make-contact", then Task.input of at least one "contact-entity" is required. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='make-contact').exists() implies input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='contact-entity').exists() | |
SDOH-Task-5 | error | Task | If Task.input is "questionnaire", then Task.output, if present, must be "questionnaire-response". : input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire').exists() implies (output.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-response').exists() or output.empty()) | |
SDOH-Task-6 | error | Task | If Task.input is "questionnaire-pdf", then Task.output, if present, must be "questionnaire-pdf-completed". : input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-pdf').exists() implies (output.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-pdf-completed').exists() or output.empty()) | |
SDOH-Task-7 | error | Task | If Task.code is "make-contact", then Task.description is required and Task.output, if present, must be "chosen-contact". : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='make-contact').exists() implies (description.exists() and (output.empty() or output.type.coding.all(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='chosen-contact').exists())) | |
dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Task | 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 | error | Task | 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 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Task | C | 0..* | Task | A request to fulfill an SDOH questionnaire or service request inv-1: Last modified date must be greater than or equal to authored-on date. SDOH-Task-1: If Task.code is “complete-questionnaire”, then exactly one Task.input of either "questionnaire", "questionnaire-pdf", or "questionnaire-url" is required and Task.input "questionnaire-category" is required. SDOH-Task-2: If Task.code is “general-information”, then Task.description is required and Task.output, if present, must be “general-information-response”. SDOH-Task-3: If Task.code is "review-material", then Task.focus of DocumentReference is required. SDOH-Task-4: If Task.code is "make-contact", then Task.input of at least one "contact-entity" is required. SDOH-Task-5: If Task.input is "questionnaire", then Task.output, if present, must be "questionnaire-response". SDOH-Task-6: If Task.input is "questionnaire-pdf", then Task.output, if present, must be "questionnaire-pdf-completed". SDOH-Task-7: If Task.code is "make-contact", then Task.description is required and Task.output, if present, must be "chosen-contact". | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | Task Instance Identifier | |||||
instantiatesCanonical | Σ | 0..1 | canonical(ActivityDefinition) | Formal definition of task | ||||
instantiatesUri | Σ | 0..1 | uri | Formal definition of task | ||||
basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this task | ||||
groupIdentifier | Σ | 0..1 | Identifier | Requisition or grouper id | ||||
Slices for partOf | Σ | 0..* | Reference(Task) | Composite task Slice: Unordered, Open by profile:resolve() | ||||
partOf:SupportedPartOf | SΣ | 0..* | Reference(SDOHCC Task For Referral Management | SDOHCC Task For Patient) | Composite task | ||||
status | ?!SΣ | 1..1 | code | draft | requested | received | accepted | + Binding: SDOHCC ValueSet Task Status (required) | ||||
statusReason | SΣ | 0..1 | CodeableConcept | Reason for current status Binding Description (No ValueSet): (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | SΣ | 1..1 | string | Plain text representation of the concept | ||||
businessStatus | Σ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding Description (No ValueSet): (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
intent | Σ | 1..1 | code | order Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Fixed Value: order | ||||
priority | S | 1..1 | code | routine | urgent Binding: SDOHCC ValueSet Task Priority (required) | ||||
code | SΣ | 1..1 | CodeableConcept | Task Type Binding: SDOHCC ValueSet Task Code (extensible) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
description | SΣC | 0..1 | string | Human-readable explanation of task | ||||
focus | SΣC | 0..1 | Reference(Resource) | What task is acting on | ||||
for | SΣ | 1..1 | Reference(US Core Patient Profile) | Beneficiary of the Task | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this task originated | ||||
executionPeriod | Σ | 0..1 | Period | Start and end time of execution | ||||
authoredOn | SC | 1..1 | dateTime | Task Creation Date | ||||
lastModified | ΣC | 0..1 | dateTime | Task Last Modified Date | ||||
requester | SΣ | 1..1 | Reference(US Core PractitionerRole Profile | US Core Organization Profile) | Who is asking for task to be done | ||||
performerType | 0..* | CodeableConcept | Requested performer Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed. | |||||
owner | SΣ | 1..1 | Reference(US Core Patient Profile | RelatedPerson) | Responsible individual | ||||
location | Σ | 0..1 | Reference(Location) | Where task occurs | ||||
reasonCode | 0..1 | CodeableConcept | Why task is needed Binding Description (No ValueSet): (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | |||||
reasonReference | 0..1 | Reference(Resource) | Why task is needed | |||||
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
note | 0..* | Annotation | Comments made about the task | |||||
relevantHistory | 0..* | Reference(Provenance) | Key events in history of the Task | |||||
restriction | 0..1 | BackboneElement | Constraints on fulfillment tasks | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
repetitions | 0..1 | positiveInt | How many times to repeat | |||||
period | 0..1 | Period | When fulfillment sought | |||||
recipient | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | |||||
Slices for input | 0..* | BackboneElement | Information used to perform task Slice: Unordered, Open by pattern:type | |||||
input:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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..1 | Content to use in performing the task | ||||||
valueBase64Binary | base64Binary | |||||||
valueBoolean | boolean | |||||||
valueCanonical | canonical(Any) | |||||||
valueCode | code | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
valueId | id | |||||||
valueInstant | instant | |||||||
valueInteger | integer | |||||||
valueMarkdown | markdown | |||||||
valueOid | oid | |||||||
valuePositiveInt | positiveInt | |||||||
valueString | string | |||||||
valueTime | time | |||||||
valueUnsignedInt | unsignedInt | |||||||
valueUri | uri | |||||||
valueUrl | url | |||||||
valueUuid | uuid | |||||||
valueAddress | Address | |||||||
valueAge | Age | |||||||
valueAnnotation | Annotation | |||||||
valueAttachment | Attachment | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueCoding | Coding | |||||||
valueContactPoint | ContactPoint | |||||||
valueCount | Count | |||||||
valueDistance | Distance | |||||||
valueDuration | Duration | |||||||
valueHumanName | HumanName | |||||||
valueIdentifier | Identifier | |||||||
valueMoney | Money | |||||||
valuePeriod | Period | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueReference | Reference(Any) | |||||||
valueSampledData | SampledData | |||||||
valueSignature | Signature | |||||||
valueTiming | Timing | |||||||
valueContactDetail | ContactDetail | |||||||
valueContributor | Contributor | |||||||
valueDataRequirement | DataRequirement | |||||||
valueExpression | Expression | |||||||
valueParameterDefinition | ParameterDefinition | |||||||
valueRelatedArtifact | RelatedArtifact | |||||||
valueTriggerDefinition | TriggerDefinition | |||||||
valueUsageContext | UsageContext | |||||||
valueDosage | Dosage | |||||||
valueMeta | Meta | |||||||
input:Questionnaire | SC | 0..1 | BackboneElement | Information used to perform task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. The codes represent types of questionnaires that the patient might be asked to complete. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | canonical(SDCBaseQuestionnaire) | Content to use in performing the task | |||||
input:QuestionnairePDF | SC | 0..1 | BackboneElement | Information used to perform task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-pdf | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | Reference(US Core DocumentReference Profile) | Content to use in performing the task | |||||
input:QuestionnaireURL | SC | 0..1 | BackboneElement | Information used to perform task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-url | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | url | Content to use in performing the task | |||||
input:QuestionnaireCategory | SC | 0..1 | BackboneElement | Information used to perform task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-category | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | CodeableConcept | Content to use in performing the task Binding: SDOHCC ValueSet SDOH Questionnaire Category (required): Types of Social Determinant of Health (SDOH) questionnaires that the patient might be asked to complete | |||||
input:Contact | SC | 0..* | BackboneElement | Information used to perform task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: contact-entity | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | Reference(SDOHCC Healthcare Service | US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Organization Profile) | Content to use in performing the task | |||||
Slices for output | C | 0..* | BackboneElement | Information produced as part of task Slice: Unordered, Open by pattern:type | ||||
output:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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..1 | Result of output | ||||||
valueBase64Binary | base64Binary | |||||||
valueBoolean | boolean | |||||||
valueCanonical | canonical(Any) | |||||||
valueCode | code | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
valueId | id | |||||||
valueInstant | instant | |||||||
valueInteger | integer | |||||||
valueMarkdown | markdown | |||||||
valueOid | oid | |||||||
valuePositiveInt | positiveInt | |||||||
valueString | string | |||||||
valueTime | time | |||||||
valueUnsignedInt | unsignedInt | |||||||
valueUri | uri | |||||||
valueUrl | url | |||||||
valueUuid | uuid | |||||||
valueAddress | Address | |||||||
valueAge | Age | |||||||
valueAnnotation | Annotation | |||||||
valueAttachment | Attachment | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueCoding | Coding | |||||||
valueContactPoint | ContactPoint | |||||||
valueCount | Count | |||||||
valueDistance | Distance | |||||||
valueDuration | Duration | |||||||
valueHumanName | HumanName | |||||||
valueIdentifier | Identifier | |||||||
valueMoney | Money | |||||||
valuePeriod | Period | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueReference | Reference(Any) | |||||||
valueSampledData | SampledData | |||||||
valueSignature | Signature | |||||||
valueTiming | Timing | |||||||
valueContactDetail | ContactDetail | |||||||
valueContributor | Contributor | |||||||
valueDataRequirement | DataRequirement | |||||||
valueExpression | Expression | |||||||
valueParameterDefinition | ParameterDefinition | |||||||
valueRelatedArtifact | RelatedArtifact | |||||||
valueTriggerDefinition | TriggerDefinition | |||||||
valueUsageContext | UsageContext | |||||||
valueDosage | Dosage | |||||||
valueMeta | Meta | |||||||
output:QuestionnaireResponse | SC | 0..1 | BackboneElement | Information produced as part of task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-response | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | Reference(SDC Questionnaire Response) | Result of output | |||||
output:QuestionnairePDFCompleted | SC | 0..1 | BackboneElement | Information produced as part of task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: questionnaire-pdf-completed | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | Reference(US Core DocumentReference Profile) | Result of output | |||||
output:GeneralInformationResponse | SC | 0..* | BackboneElement | Information produced as part of task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: general-information-response | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | markdown | Result of output | |||||
output:ChosenContact | SC | 0..1 | BackboneElement | Information produced as part of task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: chosen-contact | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | 1..1 | markdown | Result of output | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Task.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Task.status | required | SDOHCCValueSetTaskStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskStatus from this IG | ||||
Task.statusReason | example | |||||
Task.businessStatus | example | |||||
Task.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1 from the FHIR Standard | ||||
Task.priority | required | SDOHCCValueSetTaskPriorityhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskPriority from this IG | ||||
Task.code | extensible | SDOHCCValueSetTaskCodehttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetTaskCode from this IG | ||||
Task.performerType | preferred | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role from the FHIR Standard | ||||
Task.reasonCode | example | |||||
Task.input.type | example | |||||
Task.input:Questionnaire.type | example | Pattern: questionnaire | ||||
Task.input:QuestionnairePDF.type | example | Pattern: questionnaire-pdf | ||||
Task.input:QuestionnaireURL.type | example | Pattern: questionnaire-url | ||||
Task.input:QuestionnaireCategory.type | example | Pattern: questionnaire-category | ||||
Task.input:QuestionnaireCategory.value[x] | required | SDOHCCValueSetSDOHQuestionnaireCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHQuestionnaireCategory from this IG | ||||
Task.input:Contact.type | example | Pattern: contact-entity | ||||
Task.output.type | example | |||||
Task.output:QuestionnaireResponse.type | example | Pattern: questionnaire-response | ||||
Task.output:QuestionnairePDFCompleted.type | example | Pattern: questionnaire-pdf-completed | ||||
Task.output:GeneralInformationResponse.type | example | Pattern: general-information-response | ||||
Task.output:ChosenContact.type | example | Pattern: chosen-contact |
Id | Grade | Path(s) | Details | Requirements |
SDOH-Task-1 | error | Task | If Task.code is “complete-questionnaire”, then exactly one Task.input of either "questionnaire", "questionnaire-pdf", or "questionnaire-url" is required and Task.input "questionnaire-category" is required. : code.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='complete-questionnaire').exists() implies ((input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire').exists() xor input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-pdf').exists() xor input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-url').exists()) and input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='questionnaire-category').exists()) | |
SDOH-Task-2 | error | Task | If Task.code is “general-information”, then Task.description is required and Task.output, if present, must be “general-information-response”. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='general-information').exists() implies (description.exists() and (output.empty() or output.type.coding.all(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='general-information-response').exists())) | |
SDOH-Task-3 | error | Task | If Task.code is "review-material", then Task.focus of DocumentReference is required. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='review-material').exists() implies focus.resolve().all($this is DocumentReference) | |
SDOH-Task-4 | error | Task | If Task.code is "make-contact", then Task.input of at least one "contact-entity" is required. : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='make-contact').exists() implies input.type.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='contact-entity').exists() | |
SDOH-Task-5 | error | Task | If Task.input is "questionnaire", then Task.output, if present, must be "questionnaire-response". : input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire').exists() implies (output.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-response').exists() or output.empty()) | |
SDOH-Task-6 | error | Task | If Task.input is "questionnaire-pdf", then Task.output, if present, must be "questionnaire-pdf-completed". : input.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-pdf').exists() implies (output.type.coding.where(system='http://hl7.org/fhir/uv/sdc/CodeSystem/temp' and code='questionnaire-pdf-completed').exists() or output.empty()) | |
SDOH-Task-7 | error | Task | If Task.code is "make-contact", then Task.description is required and Task.output, if present, must be "chosen-contact". : code.coding.where(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='make-contact').exists() implies (description.exists() and (output.empty() or output.type.coding.all(system='http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes' and code='chosen-contact').exists())) | |
dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Task | 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 | error | Task | 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 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn |
This structure is derived from Task
Summary
Mandatory: 6 elements(1 nested mandatory element)
Must-Support: 22 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron