HL7 Terminology (THO)
5.0.0 - Publication World

This page is part of the HL7 Terminology (v5.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

CodeSystem: ActRelationshipCheckpoint

Official URL: http://terminology.hl7.org/CodeSystem/v3-ActRelationshipCheckpoint Version: 2.1.1
Active as of 2019-03-20 Responsible: Health Level 7 Computable Name: ActRelationshipCheckpoint
Other Identifiers: : urn:oid:2.16.840.1.113883.5.10

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.

This Code system is referenced in the content logical definition of the following value sets:

Properties

CodeURLTypeDescription
SpecializesCodingThe child code is a more narrow version of the concept represented by the parent code. I.e. Every child concept is also a valid parent concept. Used to allow determination of subsumption. Must be transitive, irreflexive, antisymmetric.
GeneralizesCodingInverse of Specializes. Only included as a derived relationship.
internalIdhttp://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-idcodeThe internal identifier for the concept in the HL7 Access database repository.
statushttp://hl7.org/fhir/concept-properties#statuscodeDesignation of a concept's state. Normally is not populated unless the state is retired.

This code system http://terminology.hl7.org/CodeSystem/v3-ActRelationshipCheckpoint defines the following codes:

CodeDisplayDefinitioninternalIdstatus
B beginningCondition is tested every time before execution of the service (WHILE condition DO service).10351active
E endCondition is tested at the end of a repeated service execution. The service is repeated only if the condition is true (DO service WHILE condition).10352active
S entryCondition is tested once before the service is executed (IF condition THEN service).10350active
T throughCondition 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.10353active
X exitCondition is a loop checkpoint, i.e. it is a step of an activity plan and, if negative causes the containing loop to exit.10354active

History

DateActionAuthorCustodianComment
2022-10-18reviseMarc DuteauTSMGFixing missing metadata; up-349
2022-02-17 12:00:32+1100reviseGrahame GrieveVocabulary WGPopulate Missing caseSensitive property; UP-286
2020-05-06reviseTed KleinVocabulary WGMigrated to the UTG maintenance environment and publishing tooling.