FHIR CI-Build
This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions 
| Responsible Owner: Clinical Decision Support Work Group | 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.
Clinical Reasoning
{
"$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. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-additionalImplicitRules.html) extension.",
"$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"
},
"url": {
"description": "An absolute URI that is used to identify this ArtifactAssessment when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this ArtifactAssessment is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the ArtifactAssessment is stored on different servers.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "Element.schema.json#/definitions/Element"
},
"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"
},
"version": {
"description": "The identifier that is used to identify this version of the ArtifactAssessment when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ArtifactAssessment author and is not expected to be globally unique. For example, it might be a SemVer version, timestamp (e.g. yyyymmdd), or incrementing number. There is no expectation that versions can be placed in a lexicographical sequence without additional knowledge.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "Element.schema.json#/definitions/Element"
},
"versionAlgorithmString": {
"description": "Indicates the mechanism used to compare canonical versions to determine which is more current.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_versionAlgorithmString": {
"description": "Extensions for versionAlgorithmString",
"$ref": "Element.schema.json#/definitions/Element"
},
"versionAlgorithmCoding": {
"description": "Indicates the mechanism used to compare canonical versions to determine which is more current.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"name": {
"description": "A natural language name identifying the ArtifactAssessment. This name should be usable as an identifier for the resource by machine processing applications such as code generation.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"title": {
"description": "A label for use in displaying and selecting the artifact assessment.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "Element.schema.json#/definitions/Element"
},
"status": {
"description": "The current state of this ArtifactAssessment.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"experimental": {
"description": "A Boolean value to indicate that this ArtifactAssessment is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.",
"$ref": "#/definitions/boolean"
},
"_experimental": {
"description": "Extensions for experimental",
"$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"
},
"publisher": {
"description": "The name of the organization or individual responsible for the release and ongoing maintenance of the ArtifactAssessment.",
"$ref": "#/definitions/string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "Element.schema.json#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"description": {
"description": "A free text natural language description of the ArtifactAssessment from a consumer\u0027s perspective.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"useContext": {
"description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate ArtifactAssessments.",
"items": {
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"type": "array"
},
"jurisdiction": {
"description": "A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"purpose": {
"description": "Explanation of why this ArtifactAssessment is needed and why it has been designed as it has.",
"$ref": "#/definitions/markdown"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyright": {
"description": "A copyright statement relating to the artifact assessment and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the artifact assessment.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyrightLabel": {
"description": "A short string (\u003c50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. \u0027All rights reserved\u0027, \u0027Some rights reserved\u0027).",
"$ref": "#/definitions/string"
},
"_copyrightLabel": {
"description": "Extensions for copyrightLabel",
"$ref": "Element.schema.json#/definitions/Element"
},
"usage": {
"description": "A detailed description of how the ArtifactAssessment is used from a clinical/user perspective.",
"$ref": "#/definitions/markdown"
},
"_usage": {
"description": "Extensions for usage",
"$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"
},
"effectivePeriod": {
"description": "The period during which the ArtifactAssessment content was or is planned to be in active use.",
"$ref": "Period.schema.json#/definitions/Period"
},
"author": {
"description": "An individual or organization primarily involved in the development of the content in the ArtifactAssessment.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"editor": {
"description": "An individual or organization primarily responsible for internal coherence of the ArtifactAssessment.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"reviewer": {
"description": "An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ArtifactAssessment.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"endorser": {
"description": "An individual or organization asserted by the publisher to be responsible for officially endorsing the ArtifactAssessment for use in some setting.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"relatedArtifact": {
"description": "Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.",
"items": {
"$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact"
},
"type": "array"
},
"relatesTo": {
"description": "Relationship that this ArtifactAssessment has with other FHIR or non-FHIR resources that already exist.",
"items": {
"$ref": "#/definitions/ArtifactAssessment_RelatesTo"
},
"type": "array"
},
"citeAs": {
"description": "Display of the bibliographic citation of the comment, classifier, or rating.",
"$ref": "#/definitions/markdown"
},
"_citeAs": {
"description": "Extensions for citeAs",
"$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_RelatesTo": {
"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"
},
"type": {
"description": "The type of relationship to the related artifact.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"targetUri": {
"description": "The artifact that is related to this ArtifactAssessment Resource.",
"pattern": "^\\S*$",
"type": "string"
},
"_targetUri": {
"description": "Extensions for targetUri",
"$ref": "Element.schema.json#/definitions/Element"
},
"targetAttachment": {
"description": "The artifact that is related to this ArtifactAssessment Resource.",
"$ref": "Attachment.schema.json#/definitions/Attachment"
},
"targetCanonical": {
"description": "The artifact that is related to this ArtifactAssessment Resource.",
"pattern": "^\\S*$",
"type": "string"
},
"_targetCanonical": {
"description": "Extensions for targetCanonical",
"$ref": "Element.schema.json#/definitions/Element"
},
"targetReference": {
"description": "The artifact that is related to this ArtifactAssessment Resource.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"targetMarkdown": {
"description": "The artifact that is related to this ArtifactAssessment Resource.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_targetMarkdown": {
"description": "Extensions for targetMarkdown",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"type"
]
},
"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"
},
"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.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"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"
},
"relatesTo": {
"description": "Relationship that this content component has with other FHIR or non-FHIR resources that already exist.",
"items": {
"$ref": "#/definitions/ArtifactAssessment_RelatesTo"
},
"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": "A component comment, classifier, or rating of the artifact.",
"items": {
"$ref": "#/definitions/ArtifactAssessment_Content"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
}
}
}
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.r6.core#6.0.0-snapshot1 generated on Fri, Oct 16, 2026 16:42+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R5 |
Compare to Last Ballot |
|
Propose a change