HL7 Terminology
1.0.0 - Publication

This page is part of the HL7 Terminology (v1.0.0: Release) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

ActRelationshipCheckpoint

Summary

Defining URL:http://terminology.hl7.org/ValueSet/v3-ActRelationshipCheckpoint
Version:2.0.0
Name:ActRelationshipCheckpoint
Status:Active
Title:ActRelationshipCheckpoint
Definition:

A code specifying when in the course of an Act a precondition for the Act is evaluated (e.g., before the Act starts for the first time, before every repetition, after each repetition but not before the first, or throughout the entire time of the Act.)

Discussion: This attribute is part of the workflow control suite of attributes. An action plan is a composite Act with component Acts. In a sequential plan, each component has a sequenceNumber that specifies the ordering of the plan steps. Before each step is executed and has preconditions these conditions are tested and if the test is positive, the Act has clearance for execution. The repeatNumber may indicate that an Act may be repeatedly executed. The checkpointCode is specifies when the precondition is checked and is analogous to the various conditional statements and loop constructs in programming languages "while-do" vs. "do-while" or "repeat-until" vs. "loop-exit".

For all checkpointCodes, except "end", preconditions are being checked at the time when the preceding step of the plan has terminated and this step would be next in the sequence established by the sequenceNumber attribute.

When the checkpointCode for a criterion of a repeatable Act is "end", the criterion is tested only at the end of each repetition of that Act. When the condition holds true, the next repetition is ready for execution.

When the checkpointCode is "entry" the criterion is checked at the beginning of each repetition (if any) whereas "beginning" means the criterion is checked only once before the repetition "loop" starts.

The checkpointCode "through" is special in that it requires the condition to hold throughout the execution of the Act, even throughout a single execution. As soon as the condition turns false, the Act should receive an interrupt event (see interruptibleInd) and will eventually terminate.

The checkpointCode "exit" is only used on a special plan step that represents a loop exit step. This allows an action plan to exit due to a condition tested inside the execution of this plan. Such exit criteria are sequenced with the other plan components using the ActRelationship.sequenceNumber.

OID:2.16.840.1.113883.1.11.10349 (for OID based terminology systems)
Source Resource:XML / JSON / Turtle

References

This value set is not used

Content Logical Definition

Logical Definition (CLD)

 

Expansion

This value set contains 5 concepts

Expansion based on ActRelationshipCheckpoint v2.0.0 (CodeSystem)

All codes from system http://terminology.hl7.org/CodeSystem/v3-ActRelationshipCheckpoint

CodeDisplayDefinition
BbeginningCondition is tested every time before execution of the service (WHILE condition DO service).
EendCondition is tested at the end of a repeated service execution. The service is repeated only if the condition is true (DO service WHILE condition).
SentryCondition is tested once before the service is executed (IF condition THEN service).
TthroughCondition must be true throughout the execution and the service is interrupted (asynchronously) as soon as the condition turns false (asynchronous WHILE loop). The service must be interruptible.
XexitCondition is a loop checkpoint, i.e. it is a step of an activity plan and, if negative causes the containing loop to exit.

Explanation of the columns that may appear on this page:

Level A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies
Source The source of the definition of the code (when the value set draws in codes defined elsewhere)
Code The code (used as the code in the resource instance)
Display The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application
Definition An explanation of the meaning of the concept
Comments Additional notes about how to use the code

History

DateActionAuthorCustodianComment
2020-05-06reviseTed KleinVocabulary WGMigrated to the UTG maintenance environment and publishing tooling.
2014-03-26reviseVocabulary (Woody Beeler) (no record of original request)2014T1_2014-03-26_001283 (RIM release ID)Lock all vaue sets untouched since 2014-03-26 to trackingId 2014T1_2014_03_26