Linked Care Implementation Guide
0.9.1 - ci-build

Resource Profile: LINCA Proposal List (LINCARequestOrchestration)

Defining URL:http://fhir.hl7.at/linkedcare/StructureDefinition/linca-full-proposal-list
Version:0.9.1
Name:LINCARequestOrchestration
Title:LINCA Proposal List (LINCARequestOrchestration)
Status:Draft as of 2023-11-29 14:36:10+0000
Definition:

Linked Care Profile for the overall proposal. The LINCA Proposal List serves as container for the individual placements. The placer's software creates the RequestOrchestration when (re)ordering medication.

Publisher:The Linked Care Consortium. The Linked Care Consortium,
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://fhir.hl7.at/linkedcare/StructureDefinition/linca-full-proposal-list

Formal Views of Profile Content

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

This structure is derived from RequestOrchestration

This structure is derived from RequestOrchestration

NameFlagsCard.TypeDescription & Constraintsdoco
​.. RequestOrchestration 0..*RequestOrchestrationA set of related requests
​... id 0..1idLinkedCare proposal ID, assigned by Linked Care FHIR server
​... contained 1..*LINCAProposalMedicationRequestIndividual proposal items (LINCAProposalMedicationRequest). Will be instantiated on the Linked Care Platform.
​... status 1..1codeMust be set to "active" when posting a new proposal. Assigned by Linked Care FHIR server in the other cases. Possible values: active (default), revoked (if the RequestOrchestration has been deleted in its entirety), completed (when all chains of associated ProposalMedicationRequests have entered terminal state)
​... subject 1..1Reference(CareTeam | Organization | Patient | Practitioner | RelatedPerson)Who created the proposal

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestOrchestration 0..*RequestOrchestrationA set of related requests
... id Σ0..1idLinkedCare proposal ID, assigned by Linked Care FHIR server
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 1..*LINCAProposalMedicationRequestIndividual proposal items (LINCAProposalMedicationRequest). Will be instantiated on the Linked Care Platform.
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... instantiatesCanonical Σ0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn 0..*Reference(Resource)Fulfills plan, proposal, or order
... replaces 0..*Reference(Resource)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!Σ1..1codeMust be set to "active" when posting a new proposal. Assigned by Linked Care FHIR server in the other cases. Possible values: active (default), revoked (if the RequestOrchestration has been deleted in its entirety), completed (when all chains of associated ProposalMedicationRequests have entered terminal state)
Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request.

... intent ?!Σ1..1codeThe intent of a LINCARequestOrchestration is always to propose medications for prescription (order).
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.


Required Pattern: proposal
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... code Σ0..1CodeableConceptWhat's being requested/ordered
Binding: ActionCode (example)
... subject 1..1Reference(CareTeam | Organization | Patient | Practitioner | RelatedPerson)Who created the proposal
... encounter 0..1Reference(Encounter)Created as part of
... authoredOn 0..1dateTimeWhen the request orchestration was authored
... author 0..1Reference(Device | Practitioner | PractitionerRole)Device or practitioner that authored the request orchestration
... reason 0..*CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)Why the request orchestration is needed
Binding: ActionReasonCode (example)
... goal 0..*Reference(Goal)What goals
... note 0..*AnnotationAdditional notes about the response
... action C0..*BackboneElementProposed actions, if any
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId 0..1stringPointer to specific item from the PlanDefinition
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description Σ0..1markdownShort description of the action
.... textEquivalent Σ0..1markdownStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
Binding: ActionCode (example)
.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... goal 0..*Reference(Goal)What goals
.... condition 0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): The kind of condition for the action.

..... expression 0..1ExpressionBoolean-valued expression
.... input C0..*BackboneElementInput data requirements
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringUser-visible title
..... requirement C0..1DataRequirementWhat data is provided
..... relatedData C0..1idWhat data is provided
.... output C0..*BackboneElementOutput data definition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringUser-visible title
..... requirement C0..1DataRequirementWhat data is provided
..... relatedData C0..1stringWhat data is provided
.... relatedAction 0..*BackboneElementRelationship to another action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... targetId 1..1idWhat action this is related to
..... relationship 1..1codebefore | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.

..... endRelationship 0..1codebefore | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.

..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... location 0..1CodeableReference(Location)Where it should happen
.... participant 0..*BackboneElementWho should perform the action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.

..... typeCanonical 0..1canonical(CapabilityStatement)Who or what can participate
..... typeReference 0..1Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who or what can participate
..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc
Binding: Action Participant Role (example): Defines roles played by participants for the action.

..... function 0..1CodeableConceptE.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunction (example)
..... actor[x] 0..1canonical(CapabilityStatement), Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who/what is participating?
.... type 0..1CodeableConceptcreate | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.

.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.

.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.

.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.

.... precheckBehavior 0..1codeyes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.

.... cardinalityBehavior 0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.

.... resource C0..1Reference(Resource)The target of the action
.... definition[x] 0..1Description of the activity to be performed
..... definitionCanonicalcanonical(ActivityDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUriuri
.... transform 0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... path 0..1stringThe path to the element to be set dynamically
..... expression 0..1ExpressionAn expression that provides the dynamic value for the customization
.... action 0..*See action (RequestOrchestration)Sub action

doco Documentation for this format

This structure is derived from RequestOrchestration

Differential View

This structure is derived from RequestOrchestration

NameFlagsCard.TypeDescription & Constraintsdoco
​.. RequestOrchestration 0..*RequestOrchestrationA set of related requests
​... id 0..1idLinkedCare proposal ID, assigned by Linked Care FHIR server
​... contained 1..*LINCAProposalMedicationRequestIndividual proposal items (LINCAProposalMedicationRequest). Will be instantiated on the Linked Care Platform.
​... status 1..1codeMust be set to "active" when posting a new proposal. Assigned by Linked Care FHIR server in the other cases. Possible values: active (default), revoked (if the RequestOrchestration has been deleted in its entirety), completed (when all chains of associated ProposalMedicationRequests have entered terminal state)
​... subject 1..1Reference(CareTeam | Organization | Patient | Practitioner | RelatedPerson)Who created the proposal

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestOrchestration 0..*RequestOrchestrationA set of related requests
... id Σ0..1idLinkedCare proposal ID, assigned by Linked Care FHIR server
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 1..*LINCAProposalMedicationRequestIndividual proposal items (LINCAProposalMedicationRequest). Will be instantiated on the Linked Care Platform.
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... instantiatesCanonical Σ0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn 0..*Reference(Resource)Fulfills plan, proposal, or order
... replaces 0..*Reference(Resource)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!Σ1..1codeMust be set to "active" when posting a new proposal. Assigned by Linked Care FHIR server in the other cases. Possible values: active (default), revoked (if the RequestOrchestration has been deleted in its entirety), completed (when all chains of associated ProposalMedicationRequests have entered terminal state)
Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request.

... intent ?!Σ1..1codeThe intent of a LINCARequestOrchestration is always to propose medications for prescription (order).
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.


Required Pattern: proposal
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... code Σ0..1CodeableConceptWhat's being requested/ordered
Binding: ActionCode (example)
... subject 1..1Reference(CareTeam | Organization | Patient | Practitioner | RelatedPerson)Who created the proposal
... encounter 0..1Reference(Encounter)Created as part of
... authoredOn 0..1dateTimeWhen the request orchestration was authored
... author 0..1Reference(Device | Practitioner | PractitionerRole)Device or practitioner that authored the request orchestration
... reason 0..*CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)Why the request orchestration is needed
Binding: ActionReasonCode (example)
... goal 0..*Reference(Goal)What goals
... note 0..*AnnotationAdditional notes about the response
... action C0..*BackboneElementProposed actions, if any
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId 0..1stringPointer to specific item from the PlanDefinition
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description Σ0..1markdownShort description of the action
.... textEquivalent Σ0..1markdownStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
Binding: ActionCode (example)
.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... goal 0..*Reference(Goal)What goals
.... condition 0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): The kind of condition for the action.

..... expression 0..1ExpressionBoolean-valued expression
.... input C0..*BackboneElementInput data requirements
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringUser-visible title
..... requirement C0..1DataRequirementWhat data is provided
..... relatedData C0..1idWhat data is provided
.... output C0..*BackboneElementOutput data definition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringUser-visible title
..... requirement C0..1DataRequirementWhat data is provided
..... relatedData C0..1stringWhat data is provided
.... relatedAction 0..*BackboneElementRelationship to another action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... targetId 1..1idWhat action this is related to
..... relationship 1..1codebefore | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.

..... endRelationship 0..1codebefore | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.

..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... location 0..1CodeableReference(Location)Where it should happen
.... participant 0..*BackboneElementWho should perform the action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.

..... typeCanonical 0..1canonical(CapabilityStatement)Who or what can participate
..... typeReference 0..1Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who or what can participate
..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc
Binding: Action Participant Role (example): Defines roles played by participants for the action.

..... function 0..1CodeableConceptE.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunction (example)
..... actor[x] 0..1canonical(CapabilityStatement), Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who/what is participating?
.... type 0..1CodeableConceptcreate | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.

.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.

.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.

.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.

.... precheckBehavior 0..1codeyes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.

.... cardinalityBehavior 0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.

.... resource C0..1Reference(Resource)The target of the action
.... definition[x] 0..1Description of the activity to be performed
..... definitionCanonicalcanonical(ActivityDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUriuri
.... transform 0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... path 0..1stringThe path to the element to be set dynamically
..... expression 0..1ExpressionAn expression that provides the dynamic value for the customization
.... action 0..*See action (RequestOrchestration)Sub action

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
RequestOrchestration.languagerequiredAllLanguages
RequestOrchestration.statusrequiredRequestStatus
RequestOrchestration.intentrequiredPattern: proposal
RequestOrchestration.priorityrequiredRequestPriority
RequestOrchestration.codeexampleActionCode
RequestOrchestration.reasonexampleActionReasonCode
RequestOrchestration.action.priorityrequiredRequestPriority
RequestOrchestration.action.codeexampleActionCode
RequestOrchestration.action.condition.kindrequiredActionConditionKind
RequestOrchestration.action.relatedAction.relationshiprequiredActionRelationshipType
RequestOrchestration.action.relatedAction.endRelationshiprequiredActionRelationshipType
RequestOrchestration.action.participant.typerequiredActionParticipantType
RequestOrchestration.action.participant.roleexampleActionParticipantRole
RequestOrchestration.action.participant.functionexampleActionParticipantFunction
RequestOrchestration.action.typeextensibleActionType
RequestOrchestration.action.groupingBehaviorrequiredActionGroupingBehavior
RequestOrchestration.action.selectionBehaviorrequiredActionSelectionBehavior
RequestOrchestration.action.requiredBehaviorrequiredActionRequiredBehavior
RequestOrchestration.action.precheckBehaviorrequiredActionPrecheckBehavior
RequestOrchestration.action.cardinalityBehaviorrequiredActionCardinalityBehavior

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRequestOrchestration, RequestOrchestration.containedIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRequestOrchestration, RequestOrchestration.containedIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorRequestOrchestration, RequestOrchestration.containedIf 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-5errorRequestOrchestration, RequestOrchestration.containedIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRequestOrchestration, RequestOrchestration.containedA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pld-0errorRequestOrchestration.action.inputInput data elements must have a requirement or a relatedData, but not both
: requirement.exists() xor relatedData.exists()
pld-1errorRequestOrchestration.action.outputOutput data element must have a requirement or a relatedData, but not both
: requirement.exists() xor relatedData.exists()
rqg-1errorRequestOrchestration.actionMust have resource or action but not both
: resource.exists() != action.exists()