{
"description": "A free text natural language description of the artifact from a consumer's perspective.",
"_filename": "StructureDefinition-artifact-description.json",
"package_name": "hl7.fhir.uv.extensions.r4",
"date": "2022-02-07",
"derivation": "constraint",
"publisher": "HL7 International / Clinical Decision Support",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
} ]
} ],
"purpose": "This extension is defined to support representing artifact metadata on resources that are not already canonical resources that have the corresponding element, and that behave in a definitional way, such as Medication. For example, it would not be appropriate to use this extension on a patient-specific resource such as MedicationRequest or CarePlan. Note that the apparently related [Resource Name extension](StructureDefinition-resource-instance-name.html) is only used as part of the IG publication tooling process, to populate the ImplementationGuide.definition.resource.name and description. For resources where this element was added in R5, the cross-version extension should be used rather than this extension (ConditionDefinition,DeviceDefinition,ExampleScenario,Group,ObservationDefinition,SpecimenDefinition,SubstanceDefinition,SubscriptionTopic).",
"name": "ArtifactDescription",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Extension",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "Artifact Description",
"package_version": "5.3.0-ballot-tc1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cds"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status-reason",
"valueCode": "Extensions that have been modified for R4 are still draft while real-world experience is collected"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Extension",
"min": 0,
"definition": "A free text natural language description of the artifact from a consumer's perspective.",
"isModifier": false,
"short": "Natural language description of the artifact",
"max": "1",
"id": "Extension",
"condition": [ "ele-1" ],
"comment": "This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the artifact as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the artifact is presumed to be the predominant language in the place the artifact was created).",
"base": {
"max": "*",
"min": 0,
"path": "Extension"
}
}, {
"path": "Extension.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Extension.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "0",
"id": "Extension.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"isModifier": false,
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/artifact-description",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Extension.value[x]",
"min": 1,
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).",
"isModifier": false,
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "Extension.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"isSummary": false
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
} ]
},
"status": "active",
"id": "a26ce6eb-aaee-4f89-baba-a12a3de7ed84",
"kind": "complex-type",
"url": "http://hl7.org/fhir/StructureDefinition/artifact-description",
"identifier": [ {
"value": "urn:oid:2.16.840.1.113883.4.642.5.1770",
"system": "urn:ietf:rfc:3986"
} ],
"context": [ {
"type": "element",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "5.0"
} ]
} ],
"expression": "Basic"
}, {
"type": "element",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "4.3"
} ]
} ],
"expression": "Basic"
}, {
"type": "element",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "5.0"
} ]
} ],
"expression": "Basic"
}, {
"type": "element",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "4.0"
} ]
} ],
"expression": "DeviceDefinition"
}, {
"type": "element",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "4.0"
} ]
} ],
"expression": "ExampleScenario"
}, {
"type": "element",
"expression": "Group"
}, {
"type": "element",
"expression": "Medication"
}, {
"type": "element",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "4.0"
} ]
} ],
"expression": "MedicationKnowledge"
}, {
"type": "element",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "4.0"
} ]
} ],
"expression": "ObservationDefinition"
}, {
"type": "element",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "4.0"
} ]
} ],
"expression": "SpecimenDefinition"
}, {
"type": "element",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "4.3"
} ]
} ],
"expression": "Basic"
}, {
"type": "element",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "4.3"
} ]
} ],
"expression": "Basic"
} ],
"version": "5.3.0-ballot-tc1",
"differential": {
"element": [ {
"id": "Extension",
"max": "1",
"min": 0,
"path": "Extension",
"short": "Natural language description of the artifact",
"comment": "This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the artifact as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the artifact is presumed to be the predominant language in the place the artifact was created).",
"definition": "A free text natural language description of the artifact from a consumer's perspective."
}, {
"id": "Extension.extension",
"max": "0",
"path": "Extension.extension"
}, {
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/artifact-description"
}, {
"id": "Extension.value[x]",
"min": 1,
"path": "Extension.value[x]",
"type": [ {
"code": "markdown"
} ]
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/dss",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension"
}