{
"description": "R5: `Citation.relatedArtifact` (new:RelatedArtifact)",
"_filename": "StructureDefinition-ext-R5-Citation.relatedArtifact.json",
"package_name": "hl7.fhir.uv.xver-r5.r3",
"date": "2026-03-17T21:02:03.8104715+00:00",
"derivation": "constraint",
"publisher": "FHIR Infrastructure",
"fhirVersion": "3.0.2",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"purpose": "This extension is part of the cross-version definitions generated to enable use of the\r\nelement `Citation.relatedArtifact` as defined in FHIR R5\r\nin FHIR STU3.\r\n\r\nThe source element is defined as:\r\n`Citation.relatedArtifact` 0..* `RelatedArtifact`\r\n\r\nAcross FHIR versions, the element set has been mapped as:\r\n* R5 `Citation.relatedArtifact` 0..* `RelatedArtifact`\r\n\r\nFollowing are the generation technical comments:\r\nElement `Citation.relatedArtifact` is not mapped to FHIR STU3, since FHIR R5 `Citation` is not mapped.\nElement `Citation.relatedArtifact` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"name": "ExtensionCitation_RelatedArtifact",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Extension",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "R5: Artifact related to the citation record (new)",
"package_version": "0.1.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/package-source",
"extension": [ {
"url": "packageId",
"valueId": "hl7.fhir.uv.xver-r5.r3"
}, {
"url": "version",
"valueString": "0.1.0"
}, {
"url": "uri",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r3"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r3"
} ]
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r3"
} ]
}
} ],
"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() | (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": "R5: `Citation.relatedArtifact` (new:RelatedArtifact)",
"isModifier": false,
"short": "R5: Artifact related to the citation record (new)",
"max": "*",
"id": "Extension",
"condition": [ "ele-1" ],
"comment": "Element `Citation.relatedArtifact` is not mapped to FHIR STU3, since FHIR R5 `Citation` is not mapped.\nElement `Citation.relatedArtifact` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nUse this if needed for reporting artifacts related to the citation record, NOT FOR reporting artifacts related to the cited article. For example, one may use this element to report the data source for generation of the Citation Resource instance if it was automatically generated, such as conversion from a citation repository.",
"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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"ordered": false,
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Extension.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension",
"min": 1,
"definition": "Slice to indicate the presence of a R5 `RelatedArtifact` in FHIR STU3",
"short": "DataType slice for a FHIR R5 `RelatedArtifact` value",
"type": [ {
"code": "Extension"
} ],
"sliceName": "_datatype",
"max": "1",
"id": "Extension.extension:_datatype",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:_datatype.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:_datatype.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/_datatype",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:_datatype.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"
}
}, {
"path": "Extension.extension.value[x]",
"min": 1,
"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).",
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"fixedString": "RelatedArtifact",
"id": "Extension.extension:_datatype.value[x]",
"comment": "Must be: RelatedArtifact",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.type` is mapped to FHIR STU3 element `RelatedArtifact.type` as `SourceIsBroaderThanTarget`.",
"min": 1,
"definition": "R5: `RelatedArtifact.type`",
"short": "R5: 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",
"type": [ {
"code": "Extension"
} ],
"sliceName": "type",
"max": "1",
"id": "Extension.extension:type",
"comment": "Element `RelatedArtifact.type` is mapped to FHIR STU3 element `RelatedArtifact.type` as `SourceIsBroaderThanTarget`.\nThe 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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:type.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:type.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "type",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:type.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"
}
}, {
"path": "Extension.extension.value[x]",
"min": 1,
"definition": "The type of relationship to the related artifact.",
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "The type of relationship to the related artifact.",
"valueSetUri": "http://hl7.org/fhir/uv/xver/ValueSet/R5-related-artifact-type-for-R3|0.1.0"
},
"max": "1",
"id": "Extension.extension:type.value[x]",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.classifier` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.classifier` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"definition": "R5: `RelatedArtifact.classifier` (new:CodeableConcept)",
"short": "R5: Additional classifiers (new)",
"type": [ {
"code": "Extension"
} ],
"sliceName": "classifier",
"max": "*",
"id": "Extension.extension:classifier",
"comment": "Element `RelatedArtifact.classifier` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.classifier` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:classifier.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:classifier.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "classifier",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:classifier.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"
}
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "Provides additional classifiers of the related artifact.",
"short": "Additional classifiers",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"description": "Additional classifiers for the related artifact.",
"valueSetUri": "http://hl7.org/fhir/uv/xver/ValueSet/R5-citation-artifact-classifier-for-R3|0.1.0"
},
"max": "1",
"id": "Extension.extension:classifier.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.label` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.label` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"definition": "R5: `RelatedArtifact.label` (new:string)",
"short": "R5: Short label (new)",
"type": [ {
"code": "Extension"
} ],
"sliceName": "label",
"max": "1",
"id": "Extension.extension:label",
"comment": "Element `RelatedArtifact.label` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.label` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:label.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:label.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "label",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:label.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"
}
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.",
"short": "Short label",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Extension.extension:label.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.display` is mapped to FHIR STU3 element `RelatedArtifact.display` as `Equivalent`.",
"min": 0,
"definition": "R5: `RelatedArtifact.display`",
"short": "R5: display",
"type": [ {
"code": "Extension"
} ],
"sliceName": "display",
"max": "1",
"id": "Extension.extension:display",
"comment": "Element `RelatedArtifact.display` is mapped to FHIR STU3 element `RelatedArtifact.display` as `Equivalent`.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:display.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:display.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "display",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:display.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"
}
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.",
"short": "Brief description of the related artifact",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Extension.extension:display.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.citation` is mapped to FHIR STU3 element `RelatedArtifact.citation` as `Equivalent`.",
"min": 0,
"definition": "R5: `RelatedArtifact.citation`",
"short": "R5: citation",
"type": [ {
"code": "Extension"
} ],
"sliceName": "citation",
"max": "1",
"id": "Extension.extension:citation",
"comment": "Element `RelatedArtifact.citation` is mapped to FHIR STU3 element `RelatedArtifact.citation` as `Equivalent`.\nAdditional structured information about citations should be captured as extensions.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:citation.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:citation.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "citation",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:citation.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"
}
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.",
"short": "Bibliographic citation for the artifact",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "Extension.extension:citation.value[x]",
"comment": "Additional structured information about citations should be captured as extensions.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.document` is mapped to FHIR STU3 element `RelatedArtifact.document` as `Equivalent`.",
"min": 0,
"definition": "R5: `RelatedArtifact.document`",
"short": "R5: document",
"type": [ {
"code": "Extension"
} ],
"sliceName": "document",
"max": "1",
"id": "Extension.extension:document",
"comment": "Element `RelatedArtifact.document` is mapped to FHIR STU3 element `RelatedArtifact.document` as `Equivalent`.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:document.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:document.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "document",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:document.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"
}
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "The document being referenced, represented as an attachment. This is exclusive with the resource element.",
"short": "What document is being referenced",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Attachment"
} ],
"max": "1",
"id": "Extension.extension:document.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.resource` is mapped to FHIR STU3 element `RelatedArtifact.resource` as `SourceIsBroaderThanTarget`.\nThe mappings for `RelatedArtifact.resource` do not cover the following types: canonical.\nThe mappings for `RelatedArtifact.resource` do not cover the following types based on type expansion: value.",
"min": 0,
"definition": "R5: `RelatedArtifact.resource` additional types (canonical(http://hl7.org/fhir/StructureDefinition/Resource)) additional types from child elements (value)",
"short": "R5: What artifact is being referenced additional types",
"type": [ {
"code": "Extension"
} ],
"sliceName": "resource",
"max": "1",
"id": "Extension.extension:resource",
"comment": "Element `RelatedArtifact.resource` is mapped to FHIR STU3 element `RelatedArtifact.resource` as `SourceIsBroaderThanTarget`.\nThe mappings for `RelatedArtifact.resource` do not cover the following types: canonical.\nThe mappings for `RelatedArtifact.resource` do not cover the following types based on type expansion: value.\nIf 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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:resource.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:resource.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "resource",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:resource.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"
}
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "The related artifact, such as a library, value set, profile, or other knowledge resource.",
"short": "What artifact is being referenced",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Extension.extension:resource.value[x]",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.resourceReference` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.resourceReference` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"definition": "R5: `RelatedArtifact.resourceReference` (new:Reference(Resource))",
"short": "R5: What artifact, if not a conformance resource (new)",
"type": [ {
"code": "Extension"
} ],
"sliceName": "resourceReference",
"max": "1",
"id": "Extension.extension:resourceReference",
"comment": "Element `RelatedArtifact.resourceReference` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.resourceReference` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nIf 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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:resourceReference.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:resourceReference.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "resourceReference",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:resourceReference.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"
}
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.",
"short": "What artifact, if not a conformance resource",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/5.0/StructureDefinition/profile-Resource|0.1.0"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "1",
"id": "Extension.extension:resourceReference.value[x]",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.publicationStatus` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.publicationStatus` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"definition": "R5: `RelatedArtifact.publicationStatus` (new:code)",
"short": "R5: draft | active | retired | unknown (new)",
"type": [ {
"code": "Extension"
} ],
"sliceName": "publicationStatus",
"max": "1",
"id": "Extension.extension:publicationStatus",
"comment": "Element `RelatedArtifact.publicationStatus` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.publicationStatus` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:publicationStatus.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:publicationStatus.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "publicationStatus",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:publicationStatus.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"
}
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "The publication status of the artifact being referred to.",
"short": "draft | active | retired | unknown",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "Publication status of an artifact being referred to.",
"valueSetUri": "http://hl7.org/fhir/ValueSet/publication-status|3.0.2"
},
"max": "1",
"id": "Extension.extension:publicationStatus.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.publicationDate` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.publicationDate` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"definition": "R5: `RelatedArtifact.publicationDate` (new:date)",
"short": "R5: Date of publication of the artifact being referred to (new)",
"type": [ {
"code": "Extension"
} ],
"sliceName": "publicationDate",
"max": "1",
"id": "Extension.extension:publicationDate",
"comment": "Element `RelatedArtifact.publicationDate` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.publicationDate` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:publicationDate.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:publicationDate.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "publicationDate",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:publicationDate.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"
}
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "The date of publication of the artifact being referred to.",
"short": "Date of publication of the artifact being referred to",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "Extension.extension:publicationDate.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Citation.relatedArtifact",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "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"
}
}, {
"path": "Extension.value[x]",
"min": 0,
"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).",
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"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"
} ],
"max": "0",
"id": "Extension.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
} ]
},
"status": "active",
"id": "1f5e13f2-2b3a-4a82-8e06-e6c4482111d9",
"kind": "complex-type",
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Citation.relatedArtifact",
"context": [ "Basic" ],
"version": "0.1.0",
"differential": {
"element": [ {
"path": "Extension",
"min": 0,
"definition": "R5: `Citation.relatedArtifact` (new:RelatedArtifact)",
"isModifier": false,
"short": "R5: Artifact related to the citation record (new)",
"max": "*",
"id": "Extension",
"comment": "Element `Citation.relatedArtifact` is not mapped to FHIR STU3, since FHIR R5 `Citation` is not mapped.\nElement `Citation.relatedArtifact` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nUse this if needed for reporting artifacts related to the citation record, NOT FOR reporting artifacts related to the cited article. For example, one may use this element to report the data source for generation of the Citation Resource instance if it was automatically generated, such as conversion from a citation repository.",
"base": {
"max": "*",
"min": 0,
"path": "Extension"
}
}, {
"id": "Extension.extension",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
},
"path": "Extension.extension",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Extension.extension:_datatype",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
},
"path": "Extension.extension",
"short": "DataType slice for a FHIR R5 `RelatedArtifact` value",
"sliceName": "_datatype",
"definition": "Slice to indicate the presence of a R5 `RelatedArtifact` in FHIR STU3"
}, {
"id": "Extension.extension:_datatype.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/_datatype"
}, {
"id": "Extension.extension:_datatype.value[x]",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"path": "Extension.extension.value[x]",
"type": [ {
"code": "string"
} ],
"comment": "Must be: RelatedArtifact",
"fixedString": "RelatedArtifact"
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.type` is mapped to FHIR STU3 element `RelatedArtifact.type` as `SourceIsBroaderThanTarget`.",
"min": 1,
"definition": "R5: `RelatedArtifact.type`",
"short": "R5: 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",
"sliceName": "type",
"max": "1",
"id": "Extension.extension:type",
"comment": "Element `RelatedArtifact.type` is mapped to FHIR STU3 element `RelatedArtifact.type` as `SourceIsBroaderThanTarget`.\nThe 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.",
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
}
}, {
"id": "Extension.extension:type.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "type"
}, {
"path": "Extension.extension.value[x]",
"min": 1,
"definition": "The type of relationship to the related artifact.",
"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",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "The type of relationship to the related artifact.",
"valueSetUri": "http://hl7.org/fhir/uv/xver/ValueSet/R5-related-artifact-type-for-R3|0.1.0"
},
"max": "1",
"id": "Extension.extension:type.value[x]",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.classifier` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.classifier` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"definition": "R5: `RelatedArtifact.classifier` (new:CodeableConcept)",
"short": "R5: Additional classifiers (new)",
"sliceName": "classifier",
"max": "*",
"id": "Extension.extension:classifier",
"comment": "Element `RelatedArtifact.classifier` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.classifier` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
}
}, {
"id": "Extension.extension:classifier.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "classifier"
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "Provides additional classifiers of the related artifact.",
"short": "Additional classifiers",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"description": "Additional classifiers for the related artifact.",
"valueSetUri": "http://hl7.org/fhir/uv/xver/ValueSet/R5-citation-artifact-classifier-for-R3|0.1.0"
},
"max": "1",
"id": "Extension.extension:classifier.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.label` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.label` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"definition": "R5: `RelatedArtifact.label` (new:string)",
"short": "R5: Short label (new)",
"sliceName": "label",
"max": "1",
"id": "Extension.extension:label",
"comment": "Element `RelatedArtifact.label` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.label` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
}
}, {
"id": "Extension.extension:label.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "label"
}, {
"id": "Extension.extension:label.value[x]",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"path": "Extension.extension.value[x]",
"type": [ {
"code": "string"
} ],
"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."
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.display` is mapped to FHIR STU3 element `RelatedArtifact.display` as `Equivalent`.",
"min": 0,
"definition": "R5: `RelatedArtifact.display`",
"short": "R5: display",
"sliceName": "display",
"max": "1",
"id": "Extension.extension:display",
"comment": "Element `RelatedArtifact.display` is mapped to FHIR STU3 element `RelatedArtifact.display` as `Equivalent`.",
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
}
}, {
"id": "Extension.extension:display.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "display"
}, {
"id": "Extension.extension:display.value[x]",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"path": "Extension.extension.value[x]",
"type": [ {
"code": "string"
} ],
"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."
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.citation` is mapped to FHIR STU3 element `RelatedArtifact.citation` as `Equivalent`.",
"min": 0,
"definition": "R5: `RelatedArtifact.citation`",
"short": "R5: citation",
"sliceName": "citation",
"max": "1",
"id": "Extension.extension:citation",
"comment": "Element `RelatedArtifact.citation` is mapped to FHIR STU3 element `RelatedArtifact.citation` as `Equivalent`.\nAdditional structured information about citations should be captured as extensions.",
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
}
}, {
"id": "Extension.extension:citation.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "citation"
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.",
"short": "Bibliographic citation for the artifact",
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "Extension.extension:citation.value[x]",
"comment": "Additional structured information about citations should be captured as extensions.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.document` is mapped to FHIR STU3 element `RelatedArtifact.document` as `Equivalent`.",
"min": 0,
"definition": "R5: `RelatedArtifact.document`",
"short": "R5: document",
"sliceName": "document",
"max": "1",
"id": "Extension.extension:document",
"comment": "Element `RelatedArtifact.document` is mapped to FHIR STU3 element `RelatedArtifact.document` as `Equivalent`.",
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
}
}, {
"id": "Extension.extension:document.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "document"
}, {
"id": "Extension.extension:document.value[x]",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"path": "Extension.extension.value[x]",
"type": [ {
"code": "Attachment"
} ],
"short": "What document is being referenced",
"definition": "The document being referenced, represented as an attachment. This is exclusive with the resource element."
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.resource` is mapped to FHIR STU3 element `RelatedArtifact.resource` as `SourceIsBroaderThanTarget`.\nThe mappings for `RelatedArtifact.resource` do not cover the following types: canonical.\nThe mappings for `RelatedArtifact.resource` do not cover the following types based on type expansion: value.",
"min": 0,
"definition": "R5: `RelatedArtifact.resource` additional types (canonical(http://hl7.org/fhir/StructureDefinition/Resource)) additional types from child elements (value)",
"short": "R5: What artifact is being referenced additional types",
"sliceName": "resource",
"max": "1",
"id": "Extension.extension:resource",
"comment": "Element `RelatedArtifact.resource` is mapped to FHIR STU3 element `RelatedArtifact.resource` as `SourceIsBroaderThanTarget`.\nThe mappings for `RelatedArtifact.resource` do not cover the following types: canonical.\nThe mappings for `RelatedArtifact.resource` do not cover the following types based on type expansion: value.\nIf 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.",
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
}
}, {
"id": "Extension.extension:resource.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "resource"
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "The related artifact, such as a library, value set, profile, or other knowledge resource.",
"short": "What artifact is being referenced",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Extension.extension:resource.value[x]",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.resourceReference` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.resourceReference` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"definition": "R5: `RelatedArtifact.resourceReference` (new:Reference(Resource))",
"short": "R5: What artifact, if not a conformance resource (new)",
"sliceName": "resourceReference",
"max": "1",
"id": "Extension.extension:resourceReference",
"comment": "Element `RelatedArtifact.resourceReference` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.resourceReference` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nIf 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.",
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
}
}, {
"id": "Extension.extension:resourceReference.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "resourceReference"
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.",
"short": "What artifact, if not a conformance resource",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/5.0/StructureDefinition/profile-Resource|0.1.0"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "1",
"id": "Extension.extension:resourceReference.value[x]",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.publicationStatus` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.publicationStatus` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"definition": "R5: `RelatedArtifact.publicationStatus` (new:code)",
"short": "R5: draft | active | retired | unknown (new)",
"sliceName": "publicationStatus",
"max": "1",
"id": "Extension.extension:publicationStatus",
"comment": "Element `RelatedArtifact.publicationStatus` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.publicationStatus` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
}
}, {
"id": "Extension.extension:publicationStatus.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "publicationStatus"
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "The publication status of the artifact being referred to.",
"short": "draft | active | retired | unknown",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "Publication status of an artifact being referred to.",
"valueSetUri": "http://hl7.org/fhir/ValueSet/publication-status|3.0.2"
},
"max": "1",
"id": "Extension.extension:publicationStatus.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `RelatedArtifact.publicationDate` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.publicationDate` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"definition": "R5: `RelatedArtifact.publicationDate` (new:date)",
"short": "R5: Date of publication of the artifact being referred to (new)",
"sliceName": "publicationDate",
"max": "1",
"id": "Extension.extension:publicationDate",
"comment": "Element `RelatedArtifact.publicationDate` has a context of RelatedArtifact based on following the parent source element upwards and mapping to `RelatedArtifact`.\nElement `RelatedArtifact.publicationDate` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
}
}, {
"id": "Extension.extension:publicationDate.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "publicationDate"
}, {
"id": "Extension.extension:publicationDate.value[x]",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"path": "Extension.extension.value[x]",
"type": [ {
"code": "date"
} ],
"short": "Date of publication of the artifact being referred to",
"definition": "The date of publication of the artifact being referred to."
}, {
"id": "Extension.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Citation.relatedArtifact"
}, {
"id": "Extension.value[x]",
"max": "0",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"path": "Extension.value[x]"
} ]
},
"contact": [ {
"name": "FHIR Infrastructure",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"contextType": "resource",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension"
}