description: Documents the 'knowledge artifacts' relevant to the base resource such as citations, supporting evidence, documentation of processes, caveats around testing methodology.
package_name: hl7.fhir.uv.extensions.r3
derivation: constraint
name: RelatedArtifact
type: Extension
elements:
  extension:
    array: true
    index: 0
    slicing:
      rules: open
      ordered: false
      discriminator:
      - {path: url, type: value}
      min: null
      slices:
        classifier:
          match: {url: classifier}
          schema:
            short: Additional classifiers
            array: true
            index: 11
            extensions: {}
            elements:
              extension: {index: 12}
              url:
                pattern: {type: Uri, value: classifier}
                index: 13
              value:
                choices: [valueCodeableConcept]
                index: 15
              valueCodeableConcept: {type: CodeableConcept, choiceOf: value, index: 16}
            required: [value, valueCodeableConcept]
        _datatype:
          match: {url: null}
          schema:
            type: Extension
            short: DataType name 'RelatedArtifact' from R5
            url: h
            index: 1
            elements:
              value:
                pattern: {type: String, value: RelatedArtifact}
                choices: [valueString]
                index: 3
              valueString:
                type: string
                pattern: {type: String, value: RelatedArtifact}
                choiceOf: value
                index: 4
            required: [valueString, value]
        type:
          match: {url: type}
          schema:
            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
            _required: true
            index: 5
            extensions: {}
            elements:
              extension: {index: 6}
              url:
                pattern: {type: Uri, value: type}
                index: 7
              value:
                choices: [valueCode]
                index: 9
              valueCode: {type: code, choiceOf: value, index: 10}
            required: [valueCode, value]
        resourceReference:
          match: {url: resourceReference}
          schema:
            short: What artifact, if not a conformance resource
            index: 47
            extensions: {}
            elements:
              extension: {index: 48}
              url:
                pattern: {type: Uri, value: resourceReference}
                index: 49
              value:
                choices: [valueReference]
                index: 51
              valueReference:
                type: Reference
                choiceOf: value
                refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
                index: 52
            required: [valueReference, value]
        document:
          match: {url: document}
          schema:
            short: What document is being referenced
            index: 35
            extensions: {}
            elements:
              extension: {index: 36}
              url:
                pattern: {type: Uri, value: document}
                index: 37
              value:
                choices: [valueAttachment]
                index: 39
              valueAttachment: {type: Attachment, choiceOf: value, index: 40}
            required: [valueAttachment, value]
        citation:
          match: {url: citation}
          schema:
            short: Bibliographic citation for the artifact
            index: 29
            extensions: {}
            elements:
              extension: {index: 30}
              url:
                pattern: {type: Uri, value: citation}
                index: 31
              value:
                choices: [valueMarkdown]
                index: 33
              valueMarkdown: {type: markdown, choiceOf: value, index: 34}
            required: [valueMarkdown, value]
        label:
          match: {url: label}
          schema:
            short: Short label
            index: 17
            extensions: {}
            elements:
              extension: {index: 18}
              url:
                pattern: {type: Uri, value: label}
                index: 19
              value:
                choices: [valueString]
                index: 21
              valueString: {type: string, choiceOf: value, index: 22}
            required: [valueString, value]
        resource:
          match: {url: resource}
          schema:
            short: What artifact is being referenced
            index: 41
            extensions: {}
            elements:
              extension: {index: 42}
              url:
                pattern: {type: Uri, value: resource}
                index: 43
              value:
                choices: [valueUri]
                index: 45
              valueUri: {type: uri, choiceOf: value, index: 46}
            required: [valueUri, value]
        publicationStatus:
          match: {url: publicationStatus}
          schema:
            short: draft | active | retired | unknown
            index: 53
            extensions: {}
            elements:
              extension: {index: 54}
              url:
                pattern: {type: Uri, value: publicationStatus}
                index: 55
              value:
                choices: [valueCode]
                index: 57
              valueCode: {type: code, choiceOf: value, index: 58}
            required: [valueCode, value]
        display:
          match: {url: display}
          schema:
            short: Brief description of the related artifact
            index: 23
            extensions: {}
            elements:
              extension: {index: 24}
              url:
                pattern: {type: Uri, value: display}
                index: 25
              value:
                choices: [valueString]
                index: 27
              valueString: {type: string, choiceOf: value, index: 28}
            required: [valueString, value]
        publicationDate:
          match: {url: publicationDate}
          schema:
            short: Date of publication of the artifact being referred to
            index: 59
            extensions: {}
            elements:
              extension: {index: 60}
              url:
                pattern: {type: Uri, value: publicationDate}
                index: 61
              value:
                choices: [valueDate]
                index: 63
              valueDate: {type: date, choiceOf: value, index: 64}
            required: [value, valueDate]
  url:
    pattern: {type: Uri, value: 'http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact'}
    index: 65
  value:
    choices: []
    index: 67
package_version: 5.3.0-ballot
extensions:
  classifier:
    url: classifier
    short: Additional classifiers
    array: true
    index: 11
    extensions: {}
    elements:
      extension: {index: 12}
      url:
        pattern: {type: Uri, value: classifier}
        index: 13
      value:
        choices: [valueCodeableConcept]
        index: 15
      valueCodeableConcept: {type: CodeableConcept, choiceOf: value, index: 16}
    required: [value, valueCodeableConcept]
  _datatype:
    url: h
    type: Extension
    short: DataType name 'RelatedArtifact' from R5
    index: 1
    elements:
      value:
        pattern: {type: String, value: RelatedArtifact}
        choices: [valueString]
        index: 3
      valueString:
        type: string
        pattern: {type: String, value: RelatedArtifact}
        choiceOf: value
        index: 4
    required: [valueString, value]
  type:
    url: 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
    _required: true
    index: 5
    extensions: {}
    elements:
      extension: {index: 6}
      url:
        pattern: {type: Uri, value: type}
        index: 7
      value:
        choices: [valueCode]
        index: 9
      valueCode: {type: code, choiceOf: value, index: 10}
    required: [valueCode, value]
  resourceReference:
    url: resourceReference
    short: What artifact, if not a conformance resource
    index: 47
    extensions: {}
    elements:
      extension: {index: 48}
      url:
        pattern: {type: Uri, value: resourceReference}
        index: 49
      value:
        choices: [valueReference]
        index: 51
      valueReference:
        type: Reference
        choiceOf: value
        refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
        index: 52
    required: [valueReference, value]
  document:
    url: document
    short: What document is being referenced
    index: 35
    extensions: {}
    elements:
      extension: {index: 36}
      url:
        pattern: {type: Uri, value: document}
        index: 37
      value:
        choices: [valueAttachment]
        index: 39
      valueAttachment: {type: Attachment, choiceOf: value, index: 40}
    required: [valueAttachment, value]
  citation:
    url: citation
    short: Bibliographic citation for the artifact
    index: 29
    extensions: {}
    elements:
      extension: {index: 30}
      url:
        pattern: {type: Uri, value: citation}
        index: 31
      value:
        choices: [valueMarkdown]
        index: 33
      valueMarkdown: {type: markdown, choiceOf: value, index: 34}
    required: [valueMarkdown, value]
  label:
    url: label
    short: Short label
    index: 17
    extensions: {}
    elements:
      extension: {index: 18}
      url:
        pattern: {type: Uri, value: label}
        index: 19
      value:
        choices: [valueString]
        index: 21
      valueString: {type: string, choiceOf: value, index: 22}
    required: [valueString, value]
  resource:
    url: resource
    short: What artifact is being referenced
    index: 41
    extensions: {}
    elements:
      extension: {index: 42}
      url:
        pattern: {type: Uri, value: resource}
        index: 43
      value:
        choices: [valueUri]
        index: 45
      valueUri: {type: uri, choiceOf: value, index: 46}
    required: [valueUri, value]
  publicationStatus:
    url: publicationStatus
    short: draft | active | retired | unknown
    index: 53
    extensions: {}
    elements:
      extension: {index: 54}
      url:
        pattern: {type: Uri, value: publicationStatus}
        index: 55
      value:
        choices: [valueCode]
        index: 57
      valueCode: {type: code, choiceOf: value, index: 58}
    required: [valueCode, value]
  display:
    url: display
    short: Brief description of the related artifact
    index: 23
    extensions: {}
    elements:
      extension: {index: 24}
      url:
        pattern: {type: Uri, value: display}
        index: 25
      value:
        choices: [valueString]
        index: 27
      valueString: {type: string, choiceOf: value, index: 28}
    required: [valueString, value]
  publicationDate:
    url: publicationDate
    short: Date of publication of the artifact being referred to
    index: 59
    extensions: {}
    elements:
      extension: {index: 60}
      url:
        pattern: {type: Uri, value: publicationDate}
        index: 61
      value:
        choices: [valueDate]
        index: 63
      valueDate: {type: date, choiceOf: value, index: 64}
    required: [value, valueDate]
class: extension
kind: complex-type
url: http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact
base: http://hl7.org/fhir/StructureDefinition/Extension
version: 5.3.0-ballot