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

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

Extension: Ext_R5_DocumentReference_co_profile - Detailed Descriptions

Page standards status: Informative Maturity Level: 0

Definitions for the ext-R5-DocumentReference.co.profile extension.

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

0. Extension
Definition

An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

ShortContent profile rules for the document
Control0..*
2. Extension.extension
Control1..*
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:value[x]
    Slice Namevalue[x]
    Definition

    This cross-version extension represents DocumentReference.content.profile.value[x] from http://hl7.org/fhir/StructureDefinition/DocumentReference|5.0.0 for use in FHIR R4.

    ShortCode|uri|canonical
    Control1..1
    6. Extension.extension:value[x].url
    Control1..1
    Fixed Valuevalue[x]
    8. Extension.extension:value[x].value[x]
    Definition

    This cross-version extension represents DocumentReference.content.profile.value[x] from http://hl7.org/fhir/StructureDefinition/DocumentReference|5.0.0 for use in FHIR R4.

    ShortCode|uri|canonical
    BindingThe codes SHOULD be taken from R5_v3_HL7FormatCodes_for_R4 (0.0.1-snapshot-2)
    (preferred to http://hl7.org/fhir/5.0/ValueSet/R5-v3-HL7FormatCodes-for-R4|0.0.1-snapshot-2)

    Document Format Codes.

    TypeChoice of: Coding, uri, canonical
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    10. Extension.url
    Control1..1
    Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile

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

    0. Extension
    Definition

    An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.


    Optional Extension Element - found in all resources.

    ShortContent profile rules for the documentOptional Extensions Element
    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.

    Control10..*
    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:value[x]
      Slice Namevalue[x]
      Definition

      This cross-version extension represents DocumentReference.content.profile.value[x] from http://hl7.org/fhir/StructureDefinition/DocumentReference|5.0.0 for use in FHIR R4.

      ShortCode|uri|canonicalAdditional content defined by implementations
      Control10..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:value[x].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 Valuevalue[x]
      8. Extension.extension:value[x].value[x]
      Definition

      This cross-version extension represents DocumentReference.content.profile.value[x] from http://hl7.org/fhir/StructureDefinition/DocumentReference|5.0.0 for use in FHIR R4.


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

      ShortCode|uri|canonicalValue of extension
      Control0..1
      BindingThe codes SHOULD be taken from For codes, see R5_v3_HL7FormatCodes_for_R4 (0.0.1-snapshot-2)
      (preferred to http://hl7.org/fhir/5.0/ValueSet/R5-v3-HL7FormatCodes-for-R4|0.0.1-snapshot-2)

      Document Format Codes.

      TypeChoice of: Coding, uri, canonical, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [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()))
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. 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/5.0/StructureDefinition/extension-DocumentReference.content.profile

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

      0. Extension
      Definition

      An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

      ShortContent profile rules for the document
      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
      Control1..*
      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:value[x]
        Slice Namevalue[x]
        Definition

        This cross-version extension represents DocumentReference.content.profile.value[x] from http://hl7.org/fhir/StructureDefinition/DocumentReference|5.0.0 for use in FHIR R4.

        ShortCode|uri|canonical
        Control1..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:value[x].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:value[x].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:value[x].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 Valuevalue[x]
          14. Extension.extension:value[x].value[x]
          Definition

          This cross-version extension represents DocumentReference.content.profile.value[x] from http://hl7.org/fhir/StructureDefinition/DocumentReference|5.0.0 for use in FHIR R4.

          ShortCode|uri|canonical
          Control0..1
          BindingThe codes SHOULD be taken from R5_v3_HL7FormatCodes_for_R4 (0.0.1-snapshot-2)
          (preferred to http://hl7.org/fhir/5.0/ValueSet/R5-v3-HL7FormatCodes-for-R4|0.0.1-snapshot-2)

          Document Format Codes.

          TypeChoice of: Coding, uri, canonical
          [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()))
          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/5.0/StructureDefinition/extension-DocumentReference.content.profile
          18. 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()))