Extensions for Using Data Elements from FHIR DSTU2 in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR DSTU2 in FHIR R5 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R2_DocumentManifest_R5 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-DocumentManifest resource profile.

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

0. Basic
Definition

Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.

ShortResource for non-supported content
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesZ-resource, Extension-resource, Custom-resource
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Basic.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
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()))
4. Basic.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. Basic.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, 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
Must Supportfalse
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 Basic.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. Basic.extension:masterIdentifier
    Slice NamemasterIdentifier
    Definition

    DSTU2: DocumentManifest.masterIdentifier (new:Identifier)

    ShortDSTU2: Unique Identifier for the set of documents (new)
    Comments

    Element DocumentManifest.masterIdentifier is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.masterIdentifier has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

    Control0..1
    TypeExtension(DSTU2: Unique Identifier for the set of documents (new)) (Extension Type: Identifier)
    Is Modifierfalse
    Must Supportfalse
    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())
    10. Basic.extension:recipient
    Slice Namerecipient
    Definition

    DSTU2: DocumentManifest.recipient (new:Reference(Patient,Practitioner,RelatedPerson,Organization))

    ShortDSTU2: Intended to get notified about this set of documents (new)
    Comments

    Element DocumentManifest.recipient is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.recipient has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). How the recipient receives the document set or is notified of it is up to the implementation. This element is just a statement of intent. If the recipient is a person, and it is not known whether the person is a patient or a practitioner, RelatedPerson would be the default choice.

    Control0..*
    TypeExtension(DSTU2: Intended to get notified about this set of documents (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Patient for use in FHIR R5, Patient, Cross-version Profile for DSTU2.Practitioner for use in FHIR R5, PractitionerRole, Cross-version Profile for DSTU2.RelatedPerson for use in FHIR R5, RelatedPerson, Cross-version Profile for DSTU2.Organization for use in FHIR R5, Organization))
    Is Modifierfalse
    Must Supportfalse
    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. Basic.extension:type
    Slice Nametype
    Definition

    DSTU2: DocumentManifest.type (new:CodeableConcept)

    ShortDSTU2: Kind of document set (new)
    Comments

    Element DocumentManifest.type is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.type has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

    Control0..1
    TypeExtension(DSTU2: Kind of document set (new)) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Must Supportfalse
    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())
    14. Basic.extension:source
    Slice Namesource
    Definition

    DSTU2: DocumentManifest.source (new:uri)

    ShortDSTU2: The source system/application/software (new)
    Comments

    Element DocumentManifest.source is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.source has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

    Control0..1
    TypeExtension(DSTU2: The source system/application/software (new)) (Extension Type: uri)
    Is Modifierfalse
    Must Supportfalse
    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())
    16. Basic.extension:description
    Slice Namedescription
    Definition

    DSTU2: DocumentManifest.description (new:string)

    ShortDSTU2: Human-readable description (title) (new)
    Comments

    Element DocumentManifest.description is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.description has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a "consultation" or "progress note").

    Control0..1
    TypeExtension(DSTU2: Human-readable description (title) (new)) (Extension Type: string)
    Is Modifierfalse
    Must Supportfalse
    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())
    18. Basic.extension:content
    Slice Namecontent
    Definition

    DSTU2: DocumentManifest.content (new:BackboneElement)

    ShortDSTU2: The items included (new)
    Comments

    Element DocumentManifest.content is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.content has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

    Control1..*
    TypeExtension(DSTU2: The items included (new)) (Complex Extension)
    Is Modifierfalse
    Must Supportfalse
    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())
    20. Basic.extension:related
    Slice Namerelated
    Definition

    DSTU2: DocumentManifest.related (new:BackboneElement)

    ShortDSTU2: Related things (new)
    Comments

    Element DocumentManifest.related is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.related has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). May be identifiers or resources that caused the DocumentManifest to be created.

    Control0..*
    TypeExtension(DSTU2: Related things (new)) (Complex Extension)
    Is Modifierfalse
    Must Supportfalse
    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())
    22. Basic.modifierExtension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensionExtensions that cannot be ignored
    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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Must Supportfalse
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    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 Basic.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 24. Basic.modifierExtension:status
      Slice Namestatus
      Definition

      DSTU2: DocumentManifest.status (new:code)

      ShortDSTU2: current | superseded | entered-in-error (new)
      Comments

      Element DocumentManifest.status is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.status has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

      Control1..1
      TypeExtension(DSTU2: current | superseded | entered-in-error (new)) (Extension Type: code)
      Is Modifiertrue because This extension is a modifier because the source element `DocumentManifest.status` is flagged as a modifier element.
      Must Supportfalse
      Summarytrue
      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())
      26. Basic.code
      Definition

      Identifies the 'type' of resource - equivalent to the resource name for other resources.

      ShortKind of Resource
      Comments

      Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.

      This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored.

      Control1..1
      BindingFor example codes, see BasicResourceTypeshttp://hl7.org/fhir/ValueSet/basic-resource-type|5.0.0
      (example to http://hl7.org/fhir/ValueSet/basic-resource-type|5.0.0)

      HL7-maintained set of codes for "Basic" resources

      TypeCodeableConcept
      Is Modifiertrue because This element determines what kind of resource is being represented which drives the meaning of all of the other elements.
      Must Supportfalse
      Summarytrue
      Requirements

      Must be able to distinguish different types of Basic resources.

      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()))

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

      0. Basic
      2. Basic.extension
      Control1..*
      SlicingThis element introduces a set of slices on Basic.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 4. Basic.extension:masterIdentifier
        Slice NamemasterIdentifier
        Definition

        DSTU2: DocumentManifest.masterIdentifier (new:Identifier)

        ShortDSTU2: Unique Identifier for the set of documents (new)
        Comments

        Element DocumentManifest.masterIdentifier is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.masterIdentifier has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

        Control0..1
        TypeExtension(DSTU2: Unique Identifier for the set of documents (new)) (Extension Type: Identifier)
        6. Basic.extension:recipient
        Slice Namerecipient
        Definition

        DSTU2: DocumentManifest.recipient (new:Reference(Patient,Practitioner,RelatedPerson,Organization))

        ShortDSTU2: Intended to get notified about this set of documents (new)
        Comments

        Element DocumentManifest.recipient is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.recipient has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). How the recipient receives the document set or is notified of it is up to the implementation. This element is just a statement of intent. If the recipient is a person, and it is not known whether the person is a patient or a practitioner, RelatedPerson would be the default choice.

        Control0..*
        TypeExtension(DSTU2: Intended to get notified about this set of documents (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Patient for use in FHIR R5, Patient, Cross-version Profile for DSTU2.Practitioner for use in FHIR R5, PractitionerRole, Cross-version Profile for DSTU2.RelatedPerson for use in FHIR R5, RelatedPerson, Cross-version Profile for DSTU2.Organization for use in FHIR R5, Organization))
        8. Basic.extension:type
        Slice Nametype
        Definition

        DSTU2: DocumentManifest.type (new:CodeableConcept)

        ShortDSTU2: Kind of document set (new)
        Comments

        Element DocumentManifest.type is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.type has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

        Control0..1
        TypeExtension(DSTU2: Kind of document set (new)) (Extension Type: CodeableConcept)
        10. Basic.extension:source
        Slice Namesource
        Definition

        DSTU2: DocumentManifest.source (new:uri)

        ShortDSTU2: The source system/application/software (new)
        Comments

        Element DocumentManifest.source is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.source has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

        Control0..1
        TypeExtension(DSTU2: The source system/application/software (new)) (Extension Type: uri)
        12. Basic.extension:description
        Slice Namedescription
        Definition

        DSTU2: DocumentManifest.description (new:string)

        ShortDSTU2: Human-readable description (title) (new)
        Comments

        Element DocumentManifest.description is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.description has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a "consultation" or "progress note").

        Control0..1
        TypeExtension(DSTU2: Human-readable description (title) (new)) (Extension Type: string)
        14. Basic.extension:content
        Slice Namecontent
        Definition

        DSTU2: DocumentManifest.content (new:BackboneElement)

        ShortDSTU2: The items included (new)
        Comments

        Element DocumentManifest.content is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.content has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

        Control1..*
        TypeExtension(DSTU2: The items included (new)) (Complex Extension)
        16. Basic.extension:related
        Slice Namerelated
        Definition

        DSTU2: DocumentManifest.related (new:BackboneElement)

        ShortDSTU2: Related things (new)
        Comments

        Element DocumentManifest.related is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.related has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). May be identifiers or resources that caused the DocumentManifest to be created.

        Control0..*
        TypeExtension(DSTU2: Related things (new)) (Complex Extension)
        18. Basic.modifierExtension
        Control0..*
        SlicingThis element introduces a set of slices on Basic.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 20. Basic.modifierExtension:status
          Slice Namestatus
          Definition

          DSTU2: DocumentManifest.status (new:code)

          ShortDSTU2: current | superseded | entered-in-error (new)
          Comments

          Element DocumentManifest.status is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.status has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

          Control1..1
          TypeExtension(DSTU2: current | superseded | entered-in-error (new)) (Extension Type: code)

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

          0. Basic
          Definition

          Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.

          ShortResource for non-supported content
          Control0..*
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate NamesZ-resource, Extension-resource, Custom-resource
          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
          dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
          dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
          dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
          dom-6: A resource should have narrative for robust management (text.`div`.exists())
          2. Basic.id
          Definition

          The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

          ShortLogical id of this artifact
          Comments

          Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

          Control0..1
          Typeid
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          4. Basic.meta
          Definition

          The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

          ShortMetadata about the resource
          Control0..1
          TypeMeta
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          6. Basic.implicitRules
          Definition

          A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

          ShortA set of rules under which this content was created
          Comments

          Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

          Control0..1
          Typeuri
          Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          8. Basic.language
          Definition

          The base language in which the resource is written.

          ShortLanguage of the resource content
          Comments

          Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

          Control0..1
          BindingThe codes SHALL be taken from AllLanguages
          (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

          IETF language tag for a human language

          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          10. Basic.text
          Definition

          A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

          ShortText summary of the resource, for human interpretation
          Comments

          Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

          Control0..1
          This element is affected by the following invariants: dom-6
          TypeNarrative
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesnarrative, html, xhtml, display
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          12. Basic.contained
          Definition

          These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

          ShortContained, inline Resources
          Comments

          This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

          Control0..*
          This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
          TypeResource
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          14. Basic.extension
          Definition

          An Extension

          ShortExtension
          Control1..*
          TypeExtension
          Is Modifierfalse
          Must Supportfalse
          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 Basic.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 16. Basic.extension:masterIdentifier
            Slice NamemasterIdentifier
            Definition

            DSTU2: DocumentManifest.masterIdentifier (new:Identifier)

            ShortDSTU2: Unique Identifier for the set of documents (new)
            Comments

            Element DocumentManifest.masterIdentifier is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.masterIdentifier has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

            Control0..1
            TypeExtension(DSTU2: Unique Identifier for the set of documents (new)) (Extension Type: Identifier)
            Is Modifierfalse
            Must Supportfalse
            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. Basic.extension:recipient
            Slice Namerecipient
            Definition

            DSTU2: DocumentManifest.recipient (new:Reference(Patient,Practitioner,RelatedPerson,Organization))

            ShortDSTU2: Intended to get notified about this set of documents (new)
            Comments

            Element DocumentManifest.recipient is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.recipient has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). How the recipient receives the document set or is notified of it is up to the implementation. This element is just a statement of intent. If the recipient is a person, and it is not known whether the person is a patient or a practitioner, RelatedPerson would be the default choice.

            Control0..*
            TypeExtension(DSTU2: Intended to get notified about this set of documents (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Patient for use in FHIR R5, Patient, Cross-version Profile for DSTU2.Practitioner for use in FHIR R5, PractitionerRole, Cross-version Profile for DSTU2.RelatedPerson for use in FHIR R5, RelatedPerson, Cross-version Profile for DSTU2.Organization for use in FHIR R5, Organization))
            Is Modifierfalse
            Must Supportfalse
            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())
            20. Basic.extension:type
            Slice Nametype
            Definition

            DSTU2: DocumentManifest.type (new:CodeableConcept)

            ShortDSTU2: Kind of document set (new)
            Comments

            Element DocumentManifest.type is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.type has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

            Control0..1
            TypeExtension(DSTU2: Kind of document set (new)) (Extension Type: CodeableConcept)
            Is Modifierfalse
            Must Supportfalse
            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())
            22. Basic.extension:source
            Slice Namesource
            Definition

            DSTU2: DocumentManifest.source (new:uri)

            ShortDSTU2: The source system/application/software (new)
            Comments

            Element DocumentManifest.source is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.source has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

            Control0..1
            TypeExtension(DSTU2: The source system/application/software (new)) (Extension Type: uri)
            Is Modifierfalse
            Must Supportfalse
            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())
            24. Basic.extension:description
            Slice Namedescription
            Definition

            DSTU2: DocumentManifest.description (new:string)

            ShortDSTU2: Human-readable description (title) (new)
            Comments

            Element DocumentManifest.description is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.description has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a "consultation" or "progress note").

            Control0..1
            TypeExtension(DSTU2: Human-readable description (title) (new)) (Extension Type: string)
            Is Modifierfalse
            Must Supportfalse
            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())
            26. Basic.extension:content
            Slice Namecontent
            Definition

            DSTU2: DocumentManifest.content (new:BackboneElement)

            ShortDSTU2: The items included (new)
            Comments

            Element DocumentManifest.content is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.content has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

            Control1..*
            TypeExtension(DSTU2: The items included (new)) (Complex Extension)
            Is Modifierfalse
            Must Supportfalse
            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())
            28. Basic.extension:related
            Slice Namerelated
            Definition

            DSTU2: DocumentManifest.related (new:BackboneElement)

            ShortDSTU2: Related things (new)
            Comments

            Element DocumentManifest.related is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.related has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). May be identifiers or resources that caused the DocumentManifest to be created.

            Control0..*
            TypeExtension(DSTU2: Related things (new)) (Complex Extension)
            Is Modifierfalse
            Must Supportfalse
            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())
            30. Basic.modifierExtension
            Definition

            An Extension

            ShortExtension
            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
            Must Supportfalse
            Summarytrue
            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 Basic.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 32. Basic.modifierExtension:status
              Slice Namestatus
              Definition

              DSTU2: DocumentManifest.status (new:code)

              ShortDSTU2: current | superseded | entered-in-error (new)
              Comments

              Element DocumentManifest.status is not mapped to FHIR R5, since FHIR DSTU2 DocumentManifest is not mapped. Element DocumentManifest.status has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

              Control1..1
              TypeExtension(DSTU2: current | superseded | entered-in-error (new)) (Extension Type: code)
              Is Modifiertrue because This extension is a modifier because the source element `DocumentManifest.status` is flagged as a modifier element.
              Must Supportfalse
              Summarytrue
              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())
              34. Basic.identifier
              Definition

              Identifier assigned to the resource for business purposes, outside the context of FHIR.

              ShortBusiness identifier
              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control0..*
              TypeIdentifier
              Is Modifierfalse
              Must Supportfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              36. Basic.code
              Definition

              Identifies the 'type' of resource - equivalent to the resource name for other resources.

              ShortKind of Resource
              Comments

              Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.

              This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored.

              Control1..1
              BindingFor example codes, see BasicResourceTypes
              (example to http://hl7.org/fhir/ValueSet/basic-resource-type|5.0.0)

              HL7-maintained set of codes for "Basic" resources

              TypeCodeableConcept
              Is Modifiertrue because This element determines what kind of resource is being represented which drives the meaning of all of the other elements.
              Must Supportfalse
              Summarytrue
              Requirements

              Must be able to distinguish different types of Basic resources.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              38. Basic.subject
              Definition

              Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.

              ShortIdentifies the focus of this resource
              Comments

              Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.

              Control0..1
              TypeReference(Resource)
              Is Modifierfalse
              Must Supportfalse
              Summarytrue
              Requirements

              Needed for partitioning the resource by Patient.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              40. Basic.created
              Definition

              Identifies when the resource was first created.

              ShortWhen created
              Control0..1
              TypedateTime
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supportfalse
              Summarytrue
              Requirements

              Allows ordering resource instances by time.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              42. Basic.author
              Definition

              Indicates who was responsible for creating the resource instance.

              ShortWho created
              Control0..1
              TypeReference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization, Device, CareTeam)
              Is Modifierfalse
              Must Supportfalse
              Summarytrue
              Requirements

              Needed for partitioning the resource.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))