Package | hl7.fhir.uv.crmi |
Type | OperationDefinition |
Id | crmi-approve |
FHIR Version | R4 |
Source | http://hl7.org/fhir/uv/crmi/https://build.fhir.org/ig/HL7/crmi-ig/OperationDefinition-crmi-approve.html |
URL | http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-approve |
Version | 2.0.0-cibuild |
Status | active |
Date | 2025-07-11T19:15:46+00:00 |
Name | CRMIApprove |
Title | CRMI Approve |
Realm | uv |
Authority | hl7 |
Description | 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. |
Type | true |
Kind | operation |
CapabilityStatement | |
crmi-authoring-artifact-repository | CRMI Authoring Artifact Repository |
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: OperationDefinition crmi-approve
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
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.
{ "resourceType": "OperationDefinition", "id": "crmi-approve", "text": { "status": "generated", "div": "<!-- snip (see above) -->" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "cds" } ], "url": "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-approve", "version": "2.0.0-cibuild", "name": "CRMIApprove", "title": "CRMI Approve", "status": "active", "kind": "operation", "date": "2025-07-11T19:15:46+00:00", "publisher": "HL7 International / Clinical Decision Support", "contact": [ { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/dss" } ] } ], "description": "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.", "jurisdiction": [ { "coding": [ { "system": "http://unstats.un.org/unsd/methods/m49/m49.htm", "code": "001", "display": "World" } ] } ], "code": "approve", "comment": "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.", "resource": [ "ActivityDefinition", "CapabilityStatement", "CodeSystem", "CompartmentDefinition", "ConceptMap", "ExampleScenario", "GraphDefinition", "ImplementationGuide", "Library", "Measure", "Medication", "MedicationKnowledge", "MessageDefinition", "NamingSystem", "OperationDefinition", "PlanDefinition", "Questionnaire", "SearchParameter", "StructureDefinition", "StructureMap", "Substance", "TerminologyCapabilities", "TestScript", "ValueSet" ], "system": false, "type": true, "instance": true, "parameter": [ { "name": "id", "use": "in", "min": 1, "max": "1", "documentation": "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)", "type": "string" }, { "name": "approvalDate", "use": "in", "min": 0, "max": "1", "documentation": "The date on which the artifact was approved. If one is not provided the system date will be used.", "type": "date" }, { "name": "artifactAssessmentType", "use": "in", "min": 0, "max": "1", "documentation": "If a comment is submitted as part of the approval, this parameter denotes the type of artifact comment.", "type": "code" }, { "name": "artifactAssessmentSummary", "use": "in", "min": 0, "max": "1", "documentation": "The body of the comment.", "type": "string" }, { "name": "artifactAssessmentTarget", "use": "in", "min": 0, "max": "1", "documentation": "The canonical url for the artifact being approved. The format is: [system]|[version] - e.g. http://loinc.org|2.56", "type": "canonical" }, { "name": "artifactAssessmentRelatedArtifact", "use": "in", "min": 0, "max": "1", "documentation": "Optional supporting canonical URL / Reference for the comment.", "type": "uri" }, { "name": "artifactAssessmentAuthor", "use": "in", "min": 0, "max": "1", "documentation": "A Reference to a resource containing information about the entity applying the approval.", "type": "Reference" }, { "name": "return", "use": "out", "min": 1, "max": "1", "documentation": "The Bundle result containing both the updated artifact and the ArtifactAssessment (Basic in R4) resource containing the Approval metadata", "type": "Bundle" } ] }