Extensions for Using Data Elements from FHIR R4B in FHIR STU3
0.1.0 - STU International flag

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

Resource Profile: Profile_R4B_ClinicalUseDefinition_R3 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-ClinicalUseDefinition 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..*
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-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
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.

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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. Basic.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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
Alternate Namesextensions, user content
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
  • 6. Basic.extension:type
    Slice Nametype
    Definition

    R4B: ClinicalUseDefinition.type (new:code)

    ShortR4B: indication | contraindication | interaction | undesirable-effect | warning (new)
    Comments

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

    Control1..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R4B: indication | contraindication | interaction | undesirable-effect | warning (new)) (Extension Type: code)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Basic.extension:category
    Slice Namecategory
    Definition

    R4B: ClinicalUseDefinition.category (new:CodeableConcept)

    ShortR4B: A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy", "Overdose" (new)
    Comments

    Element ClinicalUseDefinition.category is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.category has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R4B: A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy", "Overdose" (new)) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Basic.extension:status
    Slice Namestatus
    Definition

    R4B: ClinicalUseDefinition.status (new:CodeableConcept)

    ShortR4B: Whether this is a current issue or one that has been retired etc (new)
    Comments

    Element ClinicalUseDefinition.status is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.status has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R4B element ClinicalUseDefinition.status: http://hl7.org/fhir/StructureDefinition/artifact-status.

    Control0..1
    TypeExtension(http://hl7.org/fhir/StructureDefinition/artifact-status)
    12. Basic.extension:contraindication
    Slice Namecontraindication
    Definition

    R4B: ClinicalUseDefinition.contraindication (new:BackboneElement)

    ShortR4B: Specifics for when this is a contraindication (new)
    Comments

    Element ClinicalUseDefinition.contraindication is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.contraindication has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R4B: Specifics for when this is a contraindication (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. Basic.extension:otherTherapy
    Slice NameotherTherapy
    Definition

    R4B: ClinicalUseDefinition.contraindication.otherTherapy (new:BackboneElement)

    ShortR4B: Information about use of the product in relation to other therapies described as part of the contraindication (new)
    Comments

    Element ClinicalUseDefinition.contraindication.otherTherapy is part of an existing definition because parent element ClinicalUseDefinition.contraindication requires a cross-version extension. Element ClinicalUseDefinition.contraindication.otherTherapy is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.contraindication.otherTherapy has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R4B: Information about use of the product in relation to other therapies described as part of the contraindication (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    16. Basic.extension:indication
    Slice Nameindication
    Definition

    R4B: ClinicalUseDefinition.indication (new:BackboneElement)

    ShortR4B: Specifics for when this is an indication (new)
    Comments

    Element ClinicalUseDefinition.indication is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.indication has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R4B: Specifics for when this is an indication (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    18. Basic.extension:otherTherapy
    Slice NameotherTherapy
    Definition

    R4B: ClinicalUseDefinition.indication.otherTherapy (new:ClinicalUseDefinition.contraindication.otherTherapy)

    ShortR4B: The use of the medicinal product in relation to other therapies described as part of the indication (new)
    Comments

    Element ClinicalUseDefinition.indication.otherTherapy is part of an existing definition because parent element ClinicalUseDefinition.indication requires a cross-version extension. Element ClinicalUseDefinition.indication.otherTherapy is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.indication.otherTherapy has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R4B: Information about use of the product in relation to other therapies described as part of the contraindication (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    20. Basic.extension:interaction
    Slice Nameinteraction
    Definition

    R4B: ClinicalUseDefinition.interaction (new:BackboneElement)

    ShortR4B: Specifics for when this is an interaction (new)
    Comments

    Element ClinicalUseDefinition.interaction is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.interaction has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R4B: Specifics for when this is an interaction (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    22. Basic.extension:population
    Slice Namepopulation
    Definition

    R4B: ClinicalUseDefinition.population (new:Reference(Group))

    ShortR4B: The population group to which this applies (new)
    Comments

    Element ClinicalUseDefinition.population is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.population has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R4B: The population group to which this applies (new)) (Extension Type: Reference(Cross-version Profile for R4B.Group for use in FHIR STU3, Group))
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    24. Basic.extension:undesirableEffect
    Slice NameundesirableEffect
    Definition

    R4B: ClinicalUseDefinition.undesirableEffect (new:BackboneElement)

    ShortR4B: A possible negative outcome from the use of this treatment (new)
    Comments

    Element ClinicalUseDefinition.undesirableEffect is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.undesirableEffect has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R4B: A possible negative outcome from the use of this treatment (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    26. Basic.extension:warning
    Slice Namewarning
    Definition

    R4B: ClinicalUseDefinition.warning (new:BackboneElement)

    ShortR4B: Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness' (new)
    Comments

    Element ClinicalUseDefinition.warning is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.warning has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R4B: Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness' (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    28. Basic.modifierExtension
    Definition

    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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    ShortExtensions 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 No Modifier Reason provideed in previous versions of FHIR
    Alternate Namesextensions, user content
    30. 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 the it defines the meaning of the resource and cannot be ignored.

    Control1..1
    BindingFor example codes, see Basic Resource Typeshttp://hl7.org/fhir/ValueSet/basic-resource-type|3.0.2
    (example to http://hl7.org/fhir/ValueSet/basic-resource-type|3.0.2)

    Codes for identifying types of resources not yet defined by FHIR

    TypeCodeableConcept
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Summarytrue
    Requirements

    Must be able to distinguish different types of Basic resources.

    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:type
      Slice Nametype
      Definition

      R4B: ClinicalUseDefinition.type (new:code)

      ShortR4B: indication | contraindication | interaction | undesirable-effect | warning (new)
      Comments

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

      Control1..1
      TypeExtension(R4B: indication | contraindication | interaction | undesirable-effect | warning (new)) (Extension Type: code)
      6. Basic.extension:category
      Slice Namecategory
      Definition

      R4B: ClinicalUseDefinition.category (new:CodeableConcept)

      ShortR4B: A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy", "Overdose" (new)
      Comments

      Element ClinicalUseDefinition.category is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.category has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..*
      TypeExtension(R4B: A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy", "Overdose" (new)) (Extension Type: CodeableConcept)
      8. Basic.extension:status
      Slice Namestatus
      Definition

      R4B: ClinicalUseDefinition.status (new:CodeableConcept)

      ShortR4B: Whether this is a current issue or one that has been retired etc (new)
      Comments

      Element ClinicalUseDefinition.status is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.status has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R4B element ClinicalUseDefinition.status: http://hl7.org/fhir/StructureDefinition/artifact-status.

      Control0..1
      TypeExtension(http://hl7.org/fhir/StructureDefinition/artifact-status)
      10. Basic.extension:contraindication
      Slice Namecontraindication
      Definition

      R4B: ClinicalUseDefinition.contraindication (new:BackboneElement)

      ShortR4B: Specifics for when this is a contraindication (new)
      Comments

      Element ClinicalUseDefinition.contraindication is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.contraindication has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      TypeExtension(R4B: Specifics for when this is a contraindication (new)) (Complex Extension)
      12. Basic.extension:otherTherapy
      Slice NameotherTherapy
      Definition

      R4B: ClinicalUseDefinition.contraindication.otherTherapy (new:BackboneElement)

      ShortR4B: Information about use of the product in relation to other therapies described as part of the contraindication (new)
      Comments

      Element ClinicalUseDefinition.contraindication.otherTherapy is part of an existing definition because parent element ClinicalUseDefinition.contraindication requires a cross-version extension. Element ClinicalUseDefinition.contraindication.otherTherapy is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.contraindication.otherTherapy has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..*
      TypeExtension(R4B: Information about use of the product in relation to other therapies described as part of the contraindication (new)) (Complex Extension)
      14. Basic.extension:indication
      Slice Nameindication
      Definition

      R4B: ClinicalUseDefinition.indication (new:BackboneElement)

      ShortR4B: Specifics for when this is an indication (new)
      Comments

      Element ClinicalUseDefinition.indication is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.indication has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      TypeExtension(R4B: Specifics for when this is an indication (new)) (Complex Extension)
      16. Basic.extension:otherTherapy
      Slice NameotherTherapy
      Definition

      R4B: ClinicalUseDefinition.indication.otherTherapy (new:ClinicalUseDefinition.contraindication.otherTherapy)

      ShortR4B: The use of the medicinal product in relation to other therapies described as part of the indication (new)
      Comments

      Element ClinicalUseDefinition.indication.otherTherapy is part of an existing definition because parent element ClinicalUseDefinition.indication requires a cross-version extension. Element ClinicalUseDefinition.indication.otherTherapy is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.indication.otherTherapy has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..*
      TypeExtension(R4B: Information about use of the product in relation to other therapies described as part of the contraindication (new)) (Complex Extension)
      18. Basic.extension:interaction
      Slice Nameinteraction
      Definition

      R4B: ClinicalUseDefinition.interaction (new:BackboneElement)

      ShortR4B: Specifics for when this is an interaction (new)
      Comments

      Element ClinicalUseDefinition.interaction is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.interaction has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      TypeExtension(R4B: Specifics for when this is an interaction (new)) (Complex Extension)
      20. Basic.extension:population
      Slice Namepopulation
      Definition

      R4B: ClinicalUseDefinition.population (new:Reference(Group))

      ShortR4B: The population group to which this applies (new)
      Comments

      Element ClinicalUseDefinition.population is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.population has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..*
      TypeExtension(R4B: The population group to which this applies (new)) (Extension Type: Reference(Cross-version Profile for R4B.Group for use in FHIR STU3, Group))
      22. Basic.extension:undesirableEffect
      Slice NameundesirableEffect
      Definition

      R4B: ClinicalUseDefinition.undesirableEffect (new:BackboneElement)

      ShortR4B: A possible negative outcome from the use of this treatment (new)
      Comments

      Element ClinicalUseDefinition.undesirableEffect is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.undesirableEffect has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      TypeExtension(R4B: A possible negative outcome from the use of this treatment (new)) (Complex Extension)
      24. Basic.extension:warning
      Slice Namewarning
      Definition

      R4B: ClinicalUseDefinition.warning (new:BackboneElement)

      ShortR4B: Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness' (new)
      Comments

      Element ClinicalUseDefinition.warning is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.warning has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      TypeExtension(R4B: Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness' (new)) (Complex Extension)

      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..*
      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-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
      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

      The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

      Control0..1
      Typeid
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      4. Basic.meta
      Definition

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

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Summarytrue
      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.

      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.

      This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

      Control0..1
      Typeuri
      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      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
      BindingUnless not suitable, these codes SHALL be taken from Common Languages
      (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

      A human language.

      Additional BindingsPurpose
      All LanguagesMax Binding
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      10. Basic.text
      Definition

      A human-readable narrative that contains a summary of the resource, and may 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 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 in formation is added later.

      Control0..1
      This element is affected by the following invariants: dom-1
      TypeNarrative
      Alternate Namesnarrative, html, xhtml, display
      12. Basic.contained
      Definition

      These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

      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.

      Control0..*
      TypeResource
      Alternate Namesinline resources, anonymous resources, contained resources
      14. Basic.extension
      Definition

      An Extension

      ShortExtension
      Control1..*
      TypeExtension
      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:type
        Slice Nametype
        Definition

        R4B: ClinicalUseDefinition.type (new:code)

        ShortR4B: indication | contraindication | interaction | undesirable-effect | warning (new)
        Comments

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

        Control1..1
        This element is affected by the following invariants: ele-1
        TypeExtension(R4B: indication | contraindication | interaction | undesirable-effect | warning (new)) (Extension Type: code)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        18. Basic.extension:category
        Slice Namecategory
        Definition

        R4B: ClinicalUseDefinition.category (new:CodeableConcept)

        ShortR4B: A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy", "Overdose" (new)
        Comments

        Element ClinicalUseDefinition.category is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.category has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(R4B: A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy", "Overdose" (new)) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        20. Basic.extension:status
        Slice Namestatus
        Definition

        R4B: ClinicalUseDefinition.status (new:CodeableConcept)

        ShortR4B: Whether this is a current issue or one that has been retired etc (new)
        Comments

        Element ClinicalUseDefinition.status is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.status has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R4B element ClinicalUseDefinition.status: http://hl7.org/fhir/StructureDefinition/artifact-status.

        Control0..1
        TypeExtension(http://hl7.org/fhir/StructureDefinition/artifact-status)
        22. Basic.extension:contraindication
        Slice Namecontraindication
        Definition

        R4B: ClinicalUseDefinition.contraindication (new:BackboneElement)

        ShortR4B: Specifics for when this is a contraindication (new)
        Comments

        Element ClinicalUseDefinition.contraindication is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.contraindication has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(R4B: Specifics for when this is a contraindication (new)) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        24. Basic.extension:otherTherapy
        Slice NameotherTherapy
        Definition

        R4B: ClinicalUseDefinition.contraindication.otherTherapy (new:BackboneElement)

        ShortR4B: Information about use of the product in relation to other therapies described as part of the contraindication (new)
        Comments

        Element ClinicalUseDefinition.contraindication.otherTherapy is part of an existing definition because parent element ClinicalUseDefinition.contraindication requires a cross-version extension. Element ClinicalUseDefinition.contraindication.otherTherapy is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.contraindication.otherTherapy has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(R4B: Information about use of the product in relation to other therapies described as part of the contraindication (new)) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        26. Basic.extension:indication
        Slice Nameindication
        Definition

        R4B: ClinicalUseDefinition.indication (new:BackboneElement)

        ShortR4B: Specifics for when this is an indication (new)
        Comments

        Element ClinicalUseDefinition.indication is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.indication has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(R4B: Specifics for when this is an indication (new)) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        28. Basic.extension:otherTherapy
        Slice NameotherTherapy
        Definition

        R4B: ClinicalUseDefinition.indication.otherTherapy (new:ClinicalUseDefinition.contraindication.otherTherapy)

        ShortR4B: The use of the medicinal product in relation to other therapies described as part of the indication (new)
        Comments

        Element ClinicalUseDefinition.indication.otherTherapy is part of an existing definition because parent element ClinicalUseDefinition.indication requires a cross-version extension. Element ClinicalUseDefinition.indication.otherTherapy is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.indication.otherTherapy has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(R4B: Information about use of the product in relation to other therapies described as part of the contraindication (new)) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        30. Basic.extension:interaction
        Slice Nameinteraction
        Definition

        R4B: ClinicalUseDefinition.interaction (new:BackboneElement)

        ShortR4B: Specifics for when this is an interaction (new)
        Comments

        Element ClinicalUseDefinition.interaction is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.interaction has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(R4B: Specifics for when this is an interaction (new)) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        32. Basic.extension:population
        Slice Namepopulation
        Definition

        R4B: ClinicalUseDefinition.population (new:Reference(Group))

        ShortR4B: The population group to which this applies (new)
        Comments

        Element ClinicalUseDefinition.population is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.population has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(R4B: The population group to which this applies (new)) (Extension Type: Reference(Cross-version Profile for R4B.Group for use in FHIR STU3, Group))
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        34. Basic.extension:undesirableEffect
        Slice NameundesirableEffect
        Definition

        R4B: ClinicalUseDefinition.undesirableEffect (new:BackboneElement)

        ShortR4B: A possible negative outcome from the use of this treatment (new)
        Comments

        Element ClinicalUseDefinition.undesirableEffect is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.undesirableEffect has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(R4B: A possible negative outcome from the use of this treatment (new)) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        36. Basic.extension:warning
        Slice Namewarning
        Definition

        R4B: ClinicalUseDefinition.warning (new:BackboneElement)

        ShortR4B: Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness' (new)
        Comments

        Element ClinicalUseDefinition.warning is not mapped to FHIR STU3, since FHIR R4B ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.warning has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(R4B: Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness' (new)) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        38. Basic.modifierExtension
        Definition

        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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        ShortExtensions 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 No Modifier Reason provideed in previous versions of FHIR
        Alternate Namesextensions, user content
        40. 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
        Summarytrue
        42. 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 the it defines the meaning of the resource and cannot be ignored.

        Control1..1
        BindingFor example codes, see Basic Resource Types
        (example to http://hl7.org/fhir/ValueSet/basic-resource-type|3.0.2)

        Codes for identifying types of resources not yet defined by FHIR

        TypeCodeableConcept
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Requirements

        Must be able to distinguish different types of Basic resources.

        44. 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)
        Summarytrue
        Requirements

        Needed for partitioning the resource by Patient.

        46. Basic.created
        Definition

        Identifies when the resource was first created.

        ShortWhen created
        Control0..1
        Typedate
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Allows ordering resource instances by time.

        48. Basic.author
        Definition

        Indicates who was responsible for creating the resource instance.

        ShortWho created
        Control0..1
        TypeReference(Practitioner, Patient, RelatedPerson)
        Summarytrue
        Requirements

        Needed for partitioning the resource.