FHIR IG analytics| Package | hl7.fhir.uv.extensions.r3 |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-artifact-relatedArtifact.json |
| FHIR Version | R3 |
No resources found
No resources found
No narrative content found in resource
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "artifact-relatedArtifact",
"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 R3 are still draft while real-world experience is collected"
}
],
"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-tc1",
"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": "3.0.2",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"contextType": "resource",
"context": [
"CapabilityStatement",
"Basic",
"CodeSystem",
"CompartmentDefinition",
"Basic",
"ConceptMap",
"Basic",
"Basic",
"GraphDefinition",
"Group",
"ImplementationGuide",
"Medication",
"Basic",
"MessageDefinition",
"NamingSystem",
"Basic",
"OperationDefinition",
"Questionnaire",
"SearchParameter",
"Basic",
"Substance",
"Basic",
"Basic",
"StructureDefinition",
"StructureMap",
"Basic",
"ValueSet"
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"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": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"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()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
]
},
{
"id": "Extension.id",
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"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",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:_datatype",
"path": "Extension.extension",
"sliceName": "_datatype",
"short": "DataType name 'RelatedArtifact' from R5",
"definition": "DataType name 'RelatedArtifact' from R5",
"min": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/_datatype"
}
]
},
{
"id": "Extension.extension:_datatype.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:_datatype.extension",
"path": "Extension.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"
}
]
},
{
"id": "Extension.extension:_datatype.url",
"path": "Extension.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": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/_datatype",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:_datatype.value[x]",
"path": "Extension.extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"fixedString": "RelatedArtifact",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:type",
"path": "Extension.extension",
"sliceName": "type",
"short": "documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as",
"definition": "The type of relationship to the related artifact.",
"comment": "The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of \"new points to old\" and \"many points to one\", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.",
"min": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:type.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:type.extension",
"path": "Extension.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"
}
]
},
{
"id": "Extension.extension:type.url",
"path": "Extension.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": [
{
"code": "uri"
}
],
"fixedUri": "type",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:type.value[x]",
"path": "Extension.extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "The type of relationship to the related artifact."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactType"
}
],
"strength": "required",
"description": "The type of relationship to the related artifact.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:classifier",
"path": "Extension.extension",
"sliceName": "classifier",
"short": "Additional classifiers",
"definition": "Provides additional classifiers of the related artifact.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:classifier.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:classifier.extension",
"path": "Extension.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"
}
]
},
{
"id": "Extension.extension:classifier.url",
"path": "Extension.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": [
{
"code": "uri"
}
],
"fixedUri": "classifier",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:classifier.value[x]",
"path": "Extension.extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Additional classifiers for the related artifact."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactClassifier"
}
],
"strength": "example",
"description": "Additional classifiers for the related artifact.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/citation-artifact-classifier"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:label",
"path": "Extension.extension",
"sliceName": "label",
"short": "Short label",
"definition": "A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:label.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:label.extension",
"path": "Extension.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"
}
]
},
{
"id": "Extension.extension:label.url",
"path": "Extension.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": [
{
"code": "uri"
}
],
"fixedUri": "label",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:label.value[x]",
"path": "Extension.extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:display",
"path": "Extension.extension",
"sliceName": "display",
"short": "Brief description of the related artifact",
"definition": "A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:display.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:display.extension",
"path": "Extension.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"
}
]
},
{
"id": "Extension.extension:display.url",
"path": "Extension.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": [
{
"code": "uri"
}
],
"fixedUri": "display",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:display.value[x]",
"path": "Extension.extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:citation",
"path": "Extension.extension",
"sliceName": "citation",
"short": "Bibliographic citation for the artifact",
"definition": "A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.",
"comment": "Additional structured information about citations should be captured as extensions.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:citation.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:citation.extension",
"path": "Extension.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"
}
]
},
{
"id": "Extension.extension:citation.url",
"path": "Extension.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": [
{
"code": "uri"
}
],
"fixedUri": "citation",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:citation.value[x]",
"path": "Extension.extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:document",
"path": "Extension.extension",
"sliceName": "document",
"short": "What document is being referenced",
"definition": "The document being referenced, represented as an attachment. This is exclusive with the resource element.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:document.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:document.extension",
"path": "Extension.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"
}
]
},
{
"id": "Extension.extension:document.url",
"path": "Extension.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": [
{
"code": "uri"
}
],
"fixedUri": "document",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:document.value[x]",
"path": "Extension.extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:resource",
"path": "Extension.extension",
"sliceName": "resource",
"short": "What artifact is being referenced",
"definition": "The related artifact, such as a library, value set, profile, or other knowledge resource.",
"comment": "If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:resource.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:resource.extension",
"path": "Extension.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"
}
]
},
{
"id": "Extension.extension:resource.url",
"path": "Extension.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": [
{
"code": "uri"
}
],
"fixedUri": "resource",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:resource.value[x]",
"path": "Extension.extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:resourceReference",
"path": "Extension.extension",
"sliceName": "resourceReference",
"short": "What artifact, if not a conformance resource",
"definition": "The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.",
"comment": "If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:resourceReference.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:resourceReference.extension",
"path": "Extension.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"
}
]
},
{
"id": "Extension.extension:resourceReference.url",
"path": "Extension.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": [
{
"code": "uri"
}
],
"fixedUri": "resourceReference",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:resourceReference.value[x]",
"path": "Extension.extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:publicationStatus",
"path": "Extension.extension",
"sliceName": "publicationStatus",
"short": "draft | active | retired | unknown",
"definition": "The publication status of the artifact being referred to.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:publicationStatus.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:publicationStatus.extension",
"path": "Extension.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"
}
]
},
{
"id": "Extension.extension:publicationStatus.url",
"path": "Extension.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": [
{
"code": "uri"
}
],
"fixedUri": "publicationStatus",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:publicationStatus.value[x]",
"path": "Extension.extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Publication status of an artifact being referred to."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactPublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "Publication status of an artifact being referred to.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status|5.0.0"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:publicationDate",
"path": "Extension.extension",
"sliceName": "publicationDate",
"short": "Date of publication of the artifact being referred to",
"definition": "The date of publication of the artifact being referred to.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:publicationDate.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:publicationDate.extension",
"path": "Extension.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"
}
]
},
{
"id": "Extension.extension:publicationDate.url",
"path": "Extension.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": [
{
"code": "uri"
}
],
"fixedUri": "publicationDate",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:publicationDate.value[x]",
"path": "Extension.extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 0,
"max": "0",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "Meta"
}
],
"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",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"max": "*"
},
{
"id": "Extension.extension:_datatype",
"path": "Extension.extension",
"sliceName": "_datatype",
"short": "DataType name 'RelatedArtifact' from R5",
"definition": "DataType name 'RelatedArtifact' from R5",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/_datatype"
}
]
},
{
"id": "Extension.extension:_datatype.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "string"
}
],
"fixedString": "RelatedArtifact"
},
{
"id": "Extension.extension:type",
"path": "Extension.extension",
"sliceName": "type",
"short": "documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as",
"definition": "The type of relationship to the related artifact.",
"comment": "The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of \"new points to old\" and \"many points to one\", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.",
"min": 1,
"max": "1"
},
{
"id": "Extension.extension:type.extension",
"path": "Extension.extension.extension",
"max": "0"
},
{
"id": "Extension.extension:type.url",
"path": "Extension.extension.url",
"fixedUri": "type"
},
{
"id": "Extension.extension:type.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "The type of relationship to the related artifact."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactType"
}
],
"strength": "required",
"description": "The type of relationship to the related artifact.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0"
}
}
},
{
"id": "Extension.extension:classifier",
"path": "Extension.extension",
"sliceName": "classifier",
"short": "Additional classifiers",
"definition": "Provides additional classifiers of the related artifact.",
"min": 0,
"max": "*"
},
{
"id": "Extension.extension:classifier.extension",
"path": "Extension.extension.extension",
"max": "0"
},
{
"id": "Extension.extension:classifier.url",
"path": "Extension.extension.url",
"fixedUri": "classifier"
},
{
"id": "Extension.extension:classifier.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Additional classifiers for the related artifact."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactClassifier"
}
],
"strength": "example",
"description": "Additional classifiers for the related artifact.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/citation-artifact-classifier"
}
}
},
{
"id": "Extension.extension:label",
"path": "Extension.extension",
"sliceName": "label",
"short": "Short label",
"definition": "A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.",
"min": 0,
"max": "1"
},
{
"id": "Extension.extension:label.extension",
"path": "Extension.extension.extension",
"max": "0"
},
{
"id": "Extension.extension:label.url",
"path": "Extension.extension.url",
"fixedUri": "label"
},
{
"id": "Extension.extension:label.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "string"
}
]
},
{
"id": "Extension.extension:display",
"path": "Extension.extension",
"sliceName": "display",
"short": "Brief description of the related artifact",
"definition": "A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.",
"min": 0,
"max": "1"
},
{
"id": "Extension.extension:display.extension",
"path": "Extension.extension.extension",
"max": "0"
},
{
"id": "Extension.extension:display.url",
"path": "Extension.extension.url",
"fixedUri": "display"
},
{
"id": "Extension.extension:display.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "string"
}
]
},
{
"id": "Extension.extension:citation",
"path": "Extension.extension",
"sliceName": "citation",
"short": "Bibliographic citation for the artifact",
"definition": "A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.",
"comment": "Additional structured information about citations should be captured as extensions.",
"min": 0,
"max": "1"
},
{
"id": "Extension.extension:citation.extension",
"path": "Extension.extension.extension",
"max": "0"
},
{
"id": "Extension.extension:citation.url",
"path": "Extension.extension.url",
"fixedUri": "citation"
},
{
"id": "Extension.extension:citation.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "markdown"
}
]
},
{
"id": "Extension.extension:document",
"path": "Extension.extension",
"sliceName": "document",
"short": "What document is being referenced",
"definition": "The document being referenced, represented as an attachment. This is exclusive with the resource element.",
"min": 0,
"max": "1"
},
{
"id": "Extension.extension:document.extension",
"path": "Extension.extension.extension",
"max": "0"
},
{
"id": "Extension.extension:document.url",
"path": "Extension.extension.url",
"fixedUri": "document"
},
{
"id": "Extension.extension:document.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "Attachment"
}
]
},
{
"id": "Extension.extension:resource",
"path": "Extension.extension",
"sliceName": "resource",
"short": "What artifact is being referenced",
"definition": "The related artifact, such as a library, value set, profile, or other knowledge resource.",
"comment": "If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.",
"min": 0,
"max": "1"
},
{
"id": "Extension.extension:resource.extension",
"path": "Extension.extension.extension",
"max": "0"
},
{
"id": "Extension.extension:resource.url",
"path": "Extension.extension.url",
"fixedUri": "resource"
},
{
"id": "Extension.extension:resource.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "uri"
}
]
},
{
"id": "Extension.extension:resourceReference",
"path": "Extension.extension",
"sliceName": "resourceReference",
"short": "What artifact, if not a conformance resource",
"definition": "The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.",
"comment": "If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.",
"min": 0,
"max": "1"
},
{
"id": "Extension.extension:resourceReference.extension",
"path": "Extension.extension.extension",
"max": "0"
},
{
"id": "Extension.extension:resourceReference.url",
"path": "Extension.extension.url",
"fixedUri": "resourceReference"
},
{
"id": "Extension.extension:resourceReference.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"id": "Extension.extension:publicationStatus",
"path": "Extension.extension",
"sliceName": "publicationStatus",
"short": "draft | active | retired | unknown",
"definition": "The publication status of the artifact being referred to.",
"min": 0,
"max": "1"
},
{
"id": "Extension.extension:publicationStatus.extension",
"path": "Extension.extension.extension",
"max": "0"
},
{
"id": "Extension.extension:publicationStatus.url",
"path": "Extension.extension.url",
"fixedUri": "publicationStatus"
},
{
"id": "Extension.extension:publicationStatus.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Publication status of an artifact being referred to."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactPublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "Publication status of an artifact being referred to.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status|5.0.0"
}
}
},
{
"id": "Extension.extension:publicationDate",
"path": "Extension.extension",
"sliceName": "publicationDate",
"short": "Date of publication of the artifact being referred to",
"definition": "The date of publication of the artifact being referred to.",
"min": 0,
"max": "1"
},
{
"id": "Extension.extension:publicationDate.extension",
"path": "Extension.extension.extension",
"max": "0"
},
{
"id": "Extension.extension:publicationDate.url",
"path": "Extension.extension.url",
"fixedUri": "publicationDate"
},
{
"id": "Extension.extension:publicationDate.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "date"
}
]
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"min": 0,
"max": "0"
}
]
}
}