$approve

CRMI Approve

activeCanonical Resource Management Infrastructure Implementation Guide1.0.0operation7 inputs1 output

The approve operation supports applying an approval to an existing artifact, regardless of status. The operation sets the _date_ and _approvalDate_ elements of the approved artifact, and is otherwise only allowed to create ArtifactAssessment (Basic or cqf-artifactComment extensions in R4) resources in the repository.

Metadata

hl7.org/fhir
Canonical URL
http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-approve
Code
$approve
Kind
operation
Affects State
No
Publisher
HL7 International / Clinical Decision Support

Invocation Context

Can be invoked at:
Type LevelInstance Level
Target Resources:

Implementation Notes

The approve operation supports the ability of a repository to record commentary on a specific state of an artifact in an ArtifactAssessment (Basic or cqf-artifactComment extension in R4) resource by applying an approval. The artifact assessments which are added by the operation must reference a version of the artifact.

Input Parameters (7)

NameTypeCard.Description
id*string1..1The logical id of the artifact to approved. The server must know the artifact (e.g. it is defined explicitly in the server's artifacts)
approvalDatedate0..1The date on which the artifact was approved. If one is not provided the system date will be used.
artifactAssessmentTypecode0..1If a comment is submitted as part of the approval, this parameter denotes the type of artifact comment.
artifactAssessmentSummarystring0..1The body of the comment.
artifactAssessmentTargetcanonical0..1The canonical url for the artifact being approved. The format is: [system]|[version] - e.g. http://loinc.org|2.56
artifactAssessmentRelatedArtifacturi0..1Optional supporting canonical URL / Reference for the comment.
artifactAssessmentAuthorReference0..1A Reference to a resource containing information about the entity applying the approval.

Output Parameters (1)

NameTypeCard.Description
returnBundle1..1The Bundle result containing both the updated artifact and the ArtifactAssessment (Basic in R4) resource containing the Approval metadata

Additional Information

Version
1.0.0
Date
2024-05-31T16:42:56+00:00