This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

14.8.13 JSON Schema for ArtifactAssessment

Clinical Decision Support Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: No defined compartments

This is a representation of the json schema for ArtifactAssessment, which is just a part of the full JSON Schema.

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "id": "http://hl7.org/fhir/json-schema/ArtifactAssessment",
  "$ref": "#/definitions/ArtifactAssessment",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "ArtifactAssessment": {
      "description": "This Resource provides one or more comments, classifiers or ratings about a Resource and supports attribution and rights management metadata for the added content.",
      "properties": {
        "resourceType": {
          "description": "This is a ArtifactAssessment resource",
          "const": "ArtifactAssessment"
        },
        "id": {
          "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
          "$ref": "id.schema.json#/definitions/id"
        },
        "meta": {
          "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "implicitRules": {
          "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
          "$ref": "#/definitions/uri"
        },
        "_implicitRules": {
          "description": "Extensions for implicitRules",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "language": {
          "description": "The base language in which the resource is written.",
          "$ref": "#/definitions/code"
        },
        "_language": {
          "description": "Extensions for language",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
          "$ref": "Narrative.schema.json#/definitions/Narrative"
        },
        "contained": {
          "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
          "items": {
            "$ref": "ResourceList.schema.json#/definitions/ResourceList"
          },
          "type": "array"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "identifier": {
          "description": "A formal identifier that is used to identify this artifact assessment when it is represented in other formats, or referenced in a specification, model, design or an instance.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "title": {
          "description": "A short title for the assessment for use in displaying and selecting.",
          "$ref": "#/definitions/string"
        },
        "_title": {
          "description": "Extensions for title",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "citeAsReference": {
          "description": "Display of or reference to the bibliographic citation of the comment, classifier, or rating.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "citeAsMarkdown": {
          "description": "Display of or reference to the bibliographic citation of the comment, classifier, or rating.",
          "pattern": "^^[\\s\\S]+$$",
          "type": "string"
        },
        "_citeAsMarkdown": {
          "description": "Extensions for citeAsMarkdown",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "date": {
          "description": "The date  (and optionally time) when the artifact assessment was published. The date must change when the disposition changes and it must change if the workflow status code changes. In addition, it should change when the substantive content of the artifact assessment changes.",
          "$ref": "#/definitions/dateTime"
        },
        "_date": {
          "description": "Extensions for date",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "copyright": {
          "description": "A copyright statement relating to the artifact assessment and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the artifact assessment.",
          "$ref": "#/definitions/markdown"
        },
        "_copyright": {
          "description": "Extensions for copyright",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "approvalDate": {
          "description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
          "$ref": "#/definitions/date"
        },
        "_approvalDate": {
          "description": "Extensions for approvalDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "lastReviewDate": {
          "description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
          "$ref": "#/definitions/date"
        },
        "_lastReviewDate": {
          "description": "Extensions for lastReviewDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "artifactReference": {
          "description": "A reference to a resource, canonical resource, or non-FHIR resource which the comment or assessment is about.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "artifactCanonical": {
          "description": "A reference to a resource, canonical resource, or non-FHIR resource which the comment or assessment is about.",
          "pattern": "^\\S*$",
          "type": "string"
        },
        "_artifactCanonical": {
          "description": "Extensions for artifactCanonical",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "artifactUri": {
          "description": "A reference to a resource, canonical resource, or non-FHIR resource which the comment or assessment is about.",
          "pattern": "^\\S*$",
          "type": "string"
        },
        "_artifactUri": {
          "description": "Extensions for artifactUri",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "content": {
          "description": "A component comment, classifier, or rating of the artifact.",
          "items": {
            "$ref": "#/definitions/ArtifactAssessment_Content"
          },
          "type": "array"
        },
        "workflowStatus": {
          "description": "Indicates the workflow status of the comment or change request.",
          "$ref": "#/definitions/code"
        },
        "_workflowStatus": {
          "description": "Extensions for workflowStatus",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "disposition": {
          "description": "Indicates the disposition of the responsible party to the comment or change request.",
          "$ref": "#/definitions/code"
        },
        "_disposition": {
          "description": "Extensions for disposition",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "resourceType"
      ]
    },
    "ArtifactAssessment_Content": {
      "description": "This Resource provides one or more comments, classifiers or ratings about a Resource and supports attribution and rights management metadata for the added content.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "informationType": {
          "description": "The type of information this component of the content represents.",
          "$ref": "#/definitions/code"
        },
        "_informationType": {
          "description": "Extensions for informationType",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "summary": {
          "description": "A brief summary of the content of this component.",
          "$ref": "#/definitions/markdown"
        },
        "_summary": {
          "description": "Extensions for summary",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "type": {
          "description": "Indicates what type of content this component represents.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "classifier": {
          "description": "Represents a rating, classifier, or assessment of the artifact.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "quantity": {
          "description": "A quantitative rating of the artifact.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "author": {
          "description": "Indicates who or what authored the content.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "path": {
          "description": "A URI that points to what the comment is about, such as a line of text in the CQL, or a specific element in a resource.",
          "items": {
            "$ref": "#/definitions/uri"
          },
          "type": "array"
        },
        "_path": {
          "description": "Extensions for path",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "type": "array"
        },
        "relatedArtifact": {
          "description": "Additional related artifacts that provide supporting documentation, additional evidence, or further information related to the content.",
          "items": {
            "$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact"
          },
          "type": "array"
        },
        "freeToShare": {
          "description": "Acceptable to publicly share the comment, classifier or rating.",
          "$ref": "#/definitions/boolean"
        },
        "_freeToShare": {
          "description": "Extensions for freeToShare",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "component": {
          "description": "If the informationType is container, the components of the content.",
          "items": {
            "$ref": "#/definitions/ArtifactAssessment_Content"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  }
}