Canonical Resource Management Infrastructure Implementation Guide
1.0.0-snapshot - Snapshot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-snapshot: STU1 Draft) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

OperationDefinition: CRMI Approve Operation

Official URL: http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-approve Version: 1.0.0-snapshot
Draft as of 2023-03-12 Computable Name: CRMIApprove
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.33.1

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 resources in the repository.

URL: [base]/Resource/$approve

URL: [base]/Resource/[id]/$approve

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INid1..1string

The logical id of the artifact to approved. The server must know the artifact (e.g. it is defined explicitly in the server's artifacts)

INapprovalDate0..1date

The date on which the artifact was approved. If one is not provided the system date will be used.

INartifactAssessmentType0..1code

If a comment is submitted as part of the approval, this parameter denotes the type of artifact comment.

INartifactAssessmentSummary0..1string

The body of the comment.

INartifactAssessmentTarget0..1canonical

The canonical url for the artifact being approved. The format is: [system]|[version] - e.g. http://loinc.org|2.56

INartifactAssessmentRelatedArtifact0..1uri

Optional supporting canonical URL / Reference for the comment.

INartifactAssessmentAuthor0..1Reference

A Reference to a resource containing information about the entity applying the approval.

OUTreturn1..1Bundle

The Bundle result containing both the updated artifact and the ArtifactAssessment resource containing the Approval metadata

The approve operation supports the ability of a repository to record commentary on a specific state of an artifact in an ArtifactAssessment resource by applying an approval. The ArtifactAssessments which are added by the operation must reference a version of the artifact.