{
"description": "Explanation of why this artifact is needed and why it has been designed as it has.",
"_filename": "StructureDefinition-artifact-purpose.json",
"package_name": "hl7.fhir.uv.extensions",
"date": "2022-02-07",
"derivation": "constraint",
"publisher": "HL7 International / Clinical Decision Support",
"fhirVersion": "5.0.0",
"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. For example, it would not be appropriate to use this extension on a patient-specific resource such as MedicationRequest or CarePlan. For resources where this element was added in R5, the cross-version extension should be used rather than this extension (ImplementationGuide,NamingSystem,ObservationDefinition,SpecimenDefinition,SubscriptionTopic).",
"name": "ArtifactPurpose",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Extension",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "Artifact Purpose",
"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": "trial-use"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Extension",
"min": 0,
"definition": "Explanation of why this artifact is needed and why it has been designed as it has.",
"isModifier": false,
"short": "Why this artifact is defined",
"max": "1",
"id": "Extension",
"comment": "This element does not describe the usage of the artifact. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this artifact.",
"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": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"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-purpose",
"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",
"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/R5/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]",
"condition": [ "ext-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"isSummary": false
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "5.0.0"
} ]
},
"status": "active",
"id": "1f2522c7-d60b-4cac-af8f-11a02f1c5510",
"kind": "complex-type",
"url": "http://hl7.org/fhir/StructureDefinition/artifact-purpose",
"identifier": [ {
"value": "urn:oid:2.16.840.1.113883.4.642.5.1771",
"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": "ArtifactAssessment"
}, {
"type": "element",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "4.3"
} ]
} ],
"expression": "ClinicalUseDefinition"
}, {
"type": "element",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "5.0"
} ]
} ],
"expression": "ConditionDefinition"
}, {
"type": "element",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "4.0"
} ]
} ],
"expression": "DeviceDefinition"
}, {
"type": "element",
"expression": "Group"
}, {
"type": "element",
"expression": "ImplementationGuide"
}, {
"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",
"expression": "NamingSystem"
}, {
"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",
"expression": "Substance"
}, {
"type": "element",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "4.3"
} ]
} ],
"expression": "SubstanceDefinition"
}, {
"type": "element",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "4.3"
} ]
} ],
"expression": "SubscriptionTopic"
} ],
"version": "5.3.0-ballot-tc1",
"differential": {
"element": [ {
"id": "Extension",
"max": "1",
"min": 0,
"path": "Extension",
"short": "Why this artifact is defined",
"comment": "This element does not describe the usage of the artifact. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this artifact.",
"definition": "Explanation of why this artifact is needed and why it has been designed as it has."
}, {
"id": "Extension.extension",
"max": "0",
"path": "Extension.extension"
}, {
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/artifact-purpose"
}, {
"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"
}