| Package | hl7.fhir.uv.extensions |
| Resource Type | StructureDefinition |
| Id | artifact-relatedArtifact |
| FHIR Version | R5 |
| Source | http://hl7.org/fhir/extensions/https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-artifact-relatedArtifact.html |
| URL | http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
| Version | 5.3.0-ballot |
| Status | active |
| Date | 2022-02-07 |
| Name | ArtifactRelatedArtifact |
| Title | Artifact related artifact |
| Realm | uv |
| Authority | hl7 |
| Description | Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. |
| 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 (CodeSystem,ConceptMap,NamingSystem,ValueSet). |
| Type | Extension |
| Kind | complex-type |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition artifact-relatedArtifact
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..* | Extension | Additional documentation, citations, etc. | |
  extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact" | |
  value[x] | 1..1 | RelatedArtifact | Value of extension | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "artifact-relatedArtifact",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"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"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.840.1.113883.4.642.5.1754"
}
],
"version": "5.3.0-ballot",
"name": "ArtifactRelatedArtifact",
"title": "Artifact related artifact",
"status": "active",
"experimental": false,
"date": "2022-02-07",
"publisher": "HL7 International / Clinical Decision Support",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/dss"
}
]
}
],
"description": "Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"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 (CodeSystem,ConceptMap,NamingSystem,ValueSet).",
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "CapabilityStatement"
},
{
"type": "element",
"expression": "ClinicalUseDefinition"
},
{
"type": "element",
"expression": "CodeSystem"
},
{
"type": "element",
"expression": "CompartmentDefinition"
},
{
"type": "element",
"expression": "ConditionDefinition"
},
{
"type": "element",
"expression": "ConceptMap"
},
{
"type": "element",
"expression": "DeviceDefinition"
},
{
"type": "element",
"expression": "ExampleScenario"
},
{
"type": "element",
"expression": "GraphDefinition"
},
{
"type": "element",
"expression": "Group"
},
{
"type": "element",
"expression": "ImplementationGuide"
},
{
"type": "element",
"expression": "Medication"
},
{
"type": "element",
"expression": "MedicationKnowledge"
},
{
"type": "element",
"expression": "MessageDefinition"
},
{
"type": "element",
"expression": "NamingSystem"
},
{
"type": "element",
"expression": "ObservationDefinition"
},
{
"type": "element",
"expression": "OperationDefinition"
},
{
"type": "element",
"expression": "Questionnaire"
},
{
"type": "element",
"expression": "SearchParameter"
},
{
"type": "element",
"expression": "SpecimenDefinition"
},
{
"type": "element",
"expression": "Substance"
},
{
"type": "element",
"expression": "SubstanceDefinition"
},
{
"type": "element",
"expression": "SubscriptionTopic"
},
{
"type": "element",
"expression": "StructureDefinition"
},
{
"type": "element",
"expression": "StructureMap"
},
{
"type": "element",
"expression": "TerminologyCapabilities"
},
{
"type": "element",
"expression": "ValueSet"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "5.0.0"
}
],
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Additional documentation, citations, etc.",
"definition": "Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.",
"comment": "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"min": 0,
"max": "*",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Extension.id",
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Extension.url",
"path": "Extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a 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.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Value of extension",
"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).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "RelatedArtifact"
}
],
"condition": [
"ext-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Additional documentation, citations, etc.",
"definition": "Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.",
"comment": "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"min": 0,
"max": "*"
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"max": "0"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"min": 1,
"type": [
{
"code": "RelatedArtifact"
}
]
}
]
}
}