This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-review | Version: 2.0.0-ballot | |||
Standards status: Trial-use | Maturity Level: 4 | Computable Name: CRMIReview | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.33.15 |
The review operation supports applying an review to an existing artifact and all its children, regardless of status. The operation sets the date and lastReviewDate elements of the reviewed artifact, and is otherwise only allowed to create ArtifactAssessment (Basic or cqf-artifactComment extension in R4) resources in the repository.
URL: [base]/ActivityDefinition/$review
URL: [base]/ActivityDefinition/[id]/$review
URL: [base]/CapabilityStatement/$review
URL: [base]/CapabilityStatement/[id]/$review
URL: [base]/CodeSystem/$review
URL: [base]/CodeSystem/[id]/$review
URL: [base]/CompartmentDefinition/$review
URL: [base]/CompartmentDefinition/[id]/$review
URL: [base]/ConceptMap/$review
URL: [base]/ConceptMap/[id]/$review
URL: [base]/ExampleScenario/$review
URL: [base]/ExampleScenario/[id]/$review
URL: [base]/GraphDefinition/$review
URL: [base]/GraphDefinition/[id]/$review
URL: [base]/ImplementationGuide/$review
URL: [base]/ImplementationGuide/[id]/$review
URL: [base]/Library/$review
URL: [base]/Library/[id]/$review
URL: [base]/Measure/$review
URL: [base]/Measure/[id]/$review
URL: [base]/Medication/$review
URL: [base]/Medication/[id]/$review
URL: [base]/MedicationKnowledge/$review
URL: [base]/MedicationKnowledge/[id]/$review
URL: [base]/MessageDefinition/$review
URL: [base]/MessageDefinition/[id]/$review
URL: [base]/NamingSystem/$review
URL: [base]/NamingSystem/[id]/$review
URL: [base]/OperationDefinition/$review
URL: [base]/OperationDefinition/[id]/$review
URL: [base]/PlanDefinition/$review
URL: [base]/PlanDefinition/[id]/$review
URL: [base]/Questionnaire/$review
URL: [base]/Questionnaire/[id]/$review
URL: [base]/SearchParameter/$review
URL: [base]/SearchParameter/[id]/$review
URL: [base]/StructureDefinition/$review
URL: [base]/StructureDefinition/[id]/$review
URL: [base]/StructureMap/$review
URL: [base]/StructureMap/[id]/$review
URL: [base]/Substance/$review
URL: [base]/Substance/[id]/$review
URL: [base]/TerminologyCapabilities/$review
URL: [base]/TerminologyCapabilities/[id]/$review
URL: [base]/TestScript/$review
URL: [base]/TestScript/[id]/$review
URL: [base]/ValueSet/$review
URL: [base]/ValueSet/[id]/$review
Use | Name | Scope | Cardinality | Type | Binding | Documentation |
IN | id | 0..1 | string | The logical id of the artifact being reviewed. The server must know the artifact (e.g. it is defined explicitly in the server's artifacts) | ||
IN | reviewDate | 0..1 | date | The date on which the artifact was reviewed. 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 review, 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 reviewed. 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 review. | ||
OUT | return | 1..1 | Bundle | The Bundle result containing all updated artifacts and the ArtifactAssessment (Basic in R4) resource containing the review metadata |
The review 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 a review. The artifact assessments which are added by the operation must reference a version of the artifact.