This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-approve | Version: 1.0.0 | |||
Active as of 2024-05-31 | 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 (Basic or cqf-artifactComment extensions in R4) resources in the repository.
URL: [base]/ActivityDefinition/$approve
URL: [base]/ActivityDefinition/[id]/$approve
URL: [base]/CapabilityStatement/$approve
URL: [base]/CapabilityStatement/[id]/$approve
URL: [base]/CodeSystem/$approve
URL: [base]/CodeSystem/[id]/$approve
URL: [base]/CompartmentDefinition/$approve
URL: [base]/CompartmentDefinition/[id]/$approve
URL: [base]/ConceptMap/$approve
URL: [base]/ConceptMap/[id]/$approve
URL: [base]/ExampleScenario/$approve
URL: [base]/ExampleScenario/[id]/$approve
URL: [base]/GraphDefinition/$approve
URL: [base]/GraphDefinition/[id]/$approve
URL: [base]/ImplementationGuide/$approve
URL: [base]/ImplementationGuide/[id]/$approve
URL: [base]/Library/$approve
URL: [base]/Library/[id]/$approve
URL: [base]/Measure/$approve
URL: [base]/Measure/[id]/$approve
URL: [base]/Medication/$approve
URL: [base]/Medication/[id]/$approve
URL: [base]/MedicationKnowledge/$approve
URL: [base]/MedicationKnowledge/[id]/$approve
URL: [base]/MessageDefinition/$approve
URL: [base]/MessageDefinition/[id]/$approve
URL: [base]/NamingSystem/$approve
URL: [base]/NamingSystem/[id]/$approve
URL: [base]/OperationDefinition/$approve
URL: [base]/OperationDefinition/[id]/$approve
URL: [base]/PlanDefinition/$approve
URL: [base]/PlanDefinition/[id]/$approve
URL: [base]/Questionnaire/$approve
URL: [base]/Questionnaire/[id]/$approve
URL: [base]/SearchParameter/$approve
URL: [base]/SearchParameter/[id]/$approve
URL: [base]/StructureDefinition/$approve
URL: [base]/StructureDefinition/[id]/$approve
URL: [base]/StructureMap/$approve
URL: [base]/StructureMap/[id]/$approve
URL: [base]/Substance/$approve
URL: [base]/Substance/[id]/$approve
URL: [base]/TerminologyCapabilities/$approve
URL: [base]/TerminologyCapabilities/[id]/$approve
URL: [base]/TestScript/$approve
URL: [base]/TestScript/[id]/$approve
URL: [base]/ValueSet/$approve
URL: [base]/ValueSet/[id]/$approve
Parameters
Use | Name | Scope | Cardinality | Type | Binding | Documentation |
IN | id | 1..1 | string | 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) | ||
IN | approvalDate | 0..1 | date | The date on which the artifact was approved. If one is not provided the system date will be used. | ||
IN | artifactAssessmentType | 0..1 | code | If a comment is submitted as part of the approval, this parameter denotes the type of artifact comment. | ||
IN | artifactAssessmentSummary | 0..1 | string | The body of the comment. | ||
IN | artifactAssessmentTarget | 0..1 | canonical | The canonical url for the artifact being approved. The format is: [system]|[version] - e.g. http://loinc.org|2.56 | ||
IN | artifactAssessmentRelatedArtifact | 0..1 | uri | Optional supporting canonical URL / Reference for the comment. | ||
IN | artifactAssessmentAuthor | 0..1 | Reference | A Reference to a resource containing information about the entity applying the approval. | ||
OUT | return | 1..1 | Bundle | The Bundle result containing both the updated artifact and the ArtifactAssessment (Basic in R4) 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 (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.