FHIR Cross-Version Extensions package for FHIR R4 from FHIR R2
0.0.1-snapshot-2 - informative International flag

FHIR Cross-Version Extensions package for FHIR R4 from FHIR R2 - Version 0.0.1-snapshot-2. See the Directory of published versions

Extension: Ext_R2_DocumentReference_co_related - Detailed Descriptions

Page standards status: Informative Maturity Level: 0

Definitions for the ext-R2-DocumentReference.co.related extension.

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition

Related identifiers or resources associated with the DocumentReference.

ShortRelated identifiers or resources
Comments

DocumentReference.context.related maps to R4 DocumentReference.context.related. Has no type mapping So is mapped as SourceIsBroaderThanTarget.

Control0..*
2. Extension.extension
Control0..*
SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Extension.extension:identifier
    Slice Nameidentifier
    Definition

    Related identifier to this DocumentReference. If both id and ref are present they shall refer to the same thing.

    ShortIdentifier of related objects or events
    Comments

    DocumentReference.context.related maps to R4 DocumentReference.context.related. Has no type mapping So is mapped as SourceIsBroaderThanTarget.

    Control0..1
    6. Extension.extension:identifier.url
    Control1..1
    Fixed Valueidentifier
    8. Extension.extension:identifier.value[x]
    Definition

    Related identifier to this DocumentReference. If both id and ref are present they shall refer to the same thing.

    ShortIdentifier of related objects or events
    Comments

    DocumentReference.context.related maps to R4 DocumentReference.context.related. Has no type mapping So is mapped as SourceIsBroaderThanTarget.

    TypeIdentifier
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    10. Extension.extension:ref
    Slice Nameref
    Definition

    Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing.

    ShortRelated Resource
    Comments

    DocumentReference.context.related maps to R4 DocumentReference.context.related. Has no type mapping So is mapped as SourceIsBroaderThanTarget.

    Control0..1
    12. Extension.extension:ref.url
    Control1..1
    Fixed Valueref
    14. Extension.extension:ref.value[x]
    Definition

    Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing.

    ShortRelated Resource
    Comments

    DocumentReference.context.related maps to R4 DocumentReference.context.related. Has no type mapping So is mapped as SourceIsBroaderThanTarget.

    TypeReference
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    16. Extension.url
    Control1..1
    Fixed Valuehttp://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.context.related

    Guidance on how to interpret the contents of this table can be foundhere

    0. Extension
    Definition

    Related identifiers or resources associated with the DocumentReference.


    Optional Extension Element - found in all resources.

    ShortRelated identifiers or resourcesOptional Extensions Element
    Comments

    DocumentReference.context.related maps to R4 DocumentReference.context.related. Has no type mapping So is mapped as SourceIsBroaderThanTarget.

    Control0..*
    This element is affected by the following invariants: ele-1
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    2. Extension.extension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortExtensionAdditional content defined by implementations
    Comments

    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.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and ClosedOpen, and can be differentiated using the following discriminators:
    • value @ url
    • 4. Extension.extension:identifier
      Slice Nameidentifier
      Definition

      Related identifier to this DocumentReference. If both id and ref are present they shall refer to the same thing.

      ShortIdentifier of related objects or eventsAdditional content defined by implementations
      Comments

      DocumentReference.context.related maps to R4 DocumentReference.context.related. Has no type mapping So is mapped as SourceIsBroaderThanTarget.

      Control0..1*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      6. Extension.extension:identifier.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      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.

      Control1..1
      Typeuri
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valueidentifier
      8. Extension.extension:identifier.value[x]
      Definition

      Related identifier to this DocumentReference. If both id and ref are present they shall refer to the same thing.


      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortIdentifier of related objects or eventsValue of extension
      Comments

      DocumentReference.context.related maps to R4 DocumentReference.context.related. Has no type mapping So is mapped as SourceIsBroaderThanTarget.

      Control0..1
      TypeIdentifier, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. Extension.extension:ref
      Slice Nameref
      Definition

      Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing.

      ShortRelated ResourceAdditional content defined by implementations
      Comments

      DocumentReference.context.related maps to R4 DocumentReference.context.related. Has no type mapping So is mapped as SourceIsBroaderThanTarget.

      Control0..1*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      12. Extension.extension:ref.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      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.

      Control1..1
      Typeuri
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valueref
      14. Extension.extension:ref.value[x]
      Definition

      Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing.


      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortRelated ResourceValue of extension
      Comments

      DocumentReference.context.related maps to R4 DocumentReference.context.related. Has no type mapping So is mapped as SourceIsBroaderThanTarget.

      Control0..1
      TypeReference, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      16. Extension.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      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.

      Control1..1
      Typeuri
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttp://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.context.related

      Guidance on how to interpret the contents of this table can be foundhere

      0. Extension
      Definition

      Related identifiers or resources associated with the DocumentReference.

      ShortRelated identifiers or resources
      Comments

      DocumentReference.context.related maps to R4 DocumentReference.context.related. Has no type mapping So is mapped as SourceIsBroaderThanTarget.

      Control0..*
      This element is affected by the following invariants: ele-1
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      2. Extension.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      4. Extension.extension
      Definition

      An Extension

      ShortExtension
      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
      • value @ url
      • 6. Extension.extension:identifier
        Slice Nameidentifier
        Definition

        Related identifier to this DocumentReference. If both id and ref are present they shall refer to the same thing.

        ShortIdentifier of related objects or events
        Comments

        DocumentReference.context.related maps to R4 DocumentReference.context.related. Has no type mapping So is mapped as SourceIsBroaderThanTarget.

        Control0..1
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        8. Extension.extension:identifier.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        10. Extension.extension:identifier.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 12. Extension.extension:identifier.url
          Definition

          Source of the definition for the extension code - a logical name or a URL.

          Shortidentifies the meaning of the extension
          Comments

          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.

          Control1..1
          Typeuri
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          Fixed Valueidentifier
          14. Extension.extension:identifier.value[x]
          Definition

          Related identifier to this DocumentReference. If both id and ref are present they shall refer to the same thing.

          ShortIdentifier of related objects or events
          Comments

          DocumentReference.context.related maps to R4 DocumentReference.context.related. Has no type mapping So is mapped as SourceIsBroaderThanTarget.

          Control0..1
          TypeIdentifier
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          16. Extension.extension:ref
          Slice Nameref
          Definition

          Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing.

          ShortRelated Resource
          Comments

          DocumentReference.context.related maps to R4 DocumentReference.context.related. Has no type mapping So is mapped as SourceIsBroaderThanTarget.

          Control0..1
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          18. Extension.extension:ref.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          20. Extension.extension:ref.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          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.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 22. Extension.extension:ref.url
            Definition

            Source of the definition for the extension code - a logical name or a URL.

            Shortidentifies the meaning of the extension
            Comments

            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.

            Control1..1
            Typeuri
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Fixed Valueref
            24. Extension.extension:ref.value[x]
            Definition

            Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing.

            ShortRelated Resource
            Comments

            DocumentReference.context.related maps to R4 DocumentReference.context.related. Has no type mapping So is mapped as SourceIsBroaderThanTarget.

            Control0..1
            TypeReference
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            26. Extension.url
            Definition

            Source of the definition for the extension code - a logical name or a URL.

            Shortidentifies the meaning of the extension
            Comments

            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.

            Control1..1
            Typeuri
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Fixed Valuehttp://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.context.related
            28. Extension.value[x]
            Definition

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            ShortValue of extension
            Control0..1
            TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))