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

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

Extension: ExtensionContract_Term_Action_Subject - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R4-Contract.ter.act.subject extension.

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

0. Extension
Definition

R4: Contract.term.action.subject (new:BackboneElement)


Optional Extension Element - found in all resources.

ShortR4: Entity of the action (new)Optional Extensions Element
Comments

Element Contract.term.action.subject has a context of Contract.term.action based on following the parent source element upwards and mapping to Contract. Element Contract.term.action.subject 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
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())
ele-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())
2. Extension.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. 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 Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Extension.extension:reference
    Slice Namereference
    Definition

    R4: Contract.term.action.subject.reference (new:Reference(Patient,RelatedPerson,Practitioner,PractitionerRole,Device,Group,Organization))

    ShortR4: Entity of the action (new)Additional Content defined by implementations
    Comments

    Element Contract.term.action.subject.reference is part of an existing definition because parent element Contract.term.action.subject requires a cross-version extension. Element Contract.term.action.subject.reference has a context of Contract.term.action based on following the parent source element upwards and mapping to Contract. Element Contract.term.action.subject.reference has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control10..*
    TypeExtension
    Requirements

    Element Contract.term.action.subject.reference is part of an existing definition because parent element Contract.term.action.subject requires a cross-version extension. Element Contract.term.action.subject.reference has a context of Contract.term.action based on following the parent source element upwards and mapping to Contract. Element Contract.term.action.subject.reference has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    6. Extension.extension:reference.url
    Definition

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

    Shortidentifies the meaning of the extension
    Comments

    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuereference
    8. Extension.extension:reference.value[x]
    Definition

    The entity the action is performed or not performed on or for.


    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortEntity of the actionValue of extension
    Control10..1
    TypeReference(Cross-version Profile for R4.Patient for use in FHIR STU3, Patient, Cross-version Profile for R4.RelatedPerson for use in FHIR STU3, RelatedPerson, Cross-version Profile for R4.Practitioner for use in FHIR STU3, Practitioner, Cross-version Profile for R4.PractitionerRole for use in FHIR STU3, PractitionerRole, Cross-version Profile for R4.Device for use in FHIR STU3, Device, Cross-version Profile for R4.Group for use in FHIR STU3, Group, Cross-version Profile for R4.Organization for use in FHIR STU3, Organization), date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    10. Extension.extension:role
    Slice Namerole
    Definition

    R4: Contract.term.action.subject.role (new:CodeableConcept)

    ShortR4: Role type of the agent (new)Additional Content defined by implementations
    Comments

    Element Contract.term.action.subject.role is part of an existing definition because parent element Contract.term.action.subject requires a cross-version extension. Element Contract.term.action.subject.role has a context of Contract.term.action based on following the parent source element upwards and mapping to Contract. Element Contract.term.action.subject.role has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1*
    TypeExtension
    Requirements

    Element Contract.term.action.subject.role is part of an existing definition because parent element Contract.term.action.subject requires a cross-version extension. Element Contract.term.action.subject.role has a context of Contract.term.action based on following the parent source element upwards and mapping to Contract. Element Contract.term.action.subject.role has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    12. Extension.extension:role.url
    Definition

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

    Shortidentifies the meaning of the extension
    Comments

    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuerole
    14. Extension.extension:role.value[x]
    Definition

    Role type of agent assigned roles in this Contract.


    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortRole type of the agentValue of extension
    Control0..1
    BindingFor example codes, see For codes, see Contract Actor Role Codes
    (example to http://hl7.org/fhir/ValueSet/contract-actorrole|3.0.2)

    Detailed codes for the contract actor role.

    TypeCodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    16. Extension.url
    Definition

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

    Shortidentifies the meaning of the extension
    Comments

    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuehttp://hl7.org/fhir/4.0/StructureDefinition/extension-Contract.term.action.subject
    18. Extension.value[x]
    Definition

    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortValue of extension
    Control0..01
    TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

    0. Extension
    Definition

    R4: Contract.term.action.subject (new:BackboneElement)

    ShortR4: Entity of the action (new)
    Comments

    Element Contract.term.action.subject has a context of Contract.term.action based on following the parent source element upwards and mapping to Contract. Element Contract.term.action.subject has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..*
    Is Modifierfalse
    2. Extension.extension
    Control1..*
    SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. Extension.extension:reference
      Slice Namereference
      Definition

      R4: Contract.term.action.subject.reference (new:Reference(Patient,RelatedPerson,Practitioner,PractitionerRole,Device,Group,Organization))

      ShortR4: Entity of the action (new)
      Comments

      Element Contract.term.action.subject.reference is part of an existing definition because parent element Contract.term.action.subject requires a cross-version extension. Element Contract.term.action.subject.reference has a context of Contract.term.action based on following the parent source element upwards and mapping to Contract. Element Contract.term.action.subject.reference has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control1..*
      Requirements

      Element Contract.term.action.subject.reference is part of an existing definition because parent element Contract.term.action.subject requires a cross-version extension. Element Contract.term.action.subject.reference has a context of Contract.term.action based on following the parent source element upwards and mapping to Contract. Element Contract.term.action.subject.reference has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      6. Extension.extension:reference.url
      Control1..1
      Fixed Valuereference
      8. Extension.extension:reference.value[x]
      Definition

      The entity the action is performed or not performed on or for.

      ShortEntity of the action
      Control1..1
      TypeReference(Cross-version Profile for R4.Patient for use in FHIR STU3, Patient, Cross-version Profile for R4.RelatedPerson for use in FHIR STU3, RelatedPerson, Cross-version Profile for R4.Practitioner for use in FHIR STU3, Practitioner, Cross-version Profile for R4.PractitionerRole for use in FHIR STU3, PractitionerRole, Cross-version Profile for R4.Device for use in FHIR STU3, Device, Cross-version Profile for R4.Group for use in FHIR STU3, Group, Cross-version Profile for R4.Organization for use in FHIR STU3, Organization)
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      10. Extension.extension:role
      Slice Namerole
      Definition

      R4: Contract.term.action.subject.role (new:CodeableConcept)

      ShortR4: Role type of the agent (new)
      Comments

      Element Contract.term.action.subject.role is part of an existing definition because parent element Contract.term.action.subject requires a cross-version extension. Element Contract.term.action.subject.role has a context of Contract.term.action based on following the parent source element upwards and mapping to Contract. Element Contract.term.action.subject.role has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      Requirements

      Element Contract.term.action.subject.role is part of an existing definition because parent element Contract.term.action.subject requires a cross-version extension. Element Contract.term.action.subject.role has a context of Contract.term.action based on following the parent source element upwards and mapping to Contract. Element Contract.term.action.subject.role has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      12. Extension.extension:role.url
      Control1..1
      Fixed Valuerole
      14. Extension.extension:role.value[x]
      Definition

      Role type of agent assigned roles in this Contract.

      ShortRole type of the agent
      Control0..1
      BindingFor example codes, see Contract Actor Role Codes
      (example to http://hl7.org/fhir/ValueSet/contract-actorrole|3.0.2)

      Detailed codes for the contract actor role.

      TypeCodeableConcept
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      16. Extension.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/4.0/StructureDefinition/extension-Contract.term.action.subject
      18. Extension.value[x]
      Control0..0

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

      0. Extension
      Definition

      R4: Contract.term.action.subject (new:BackboneElement)

      ShortR4: Entity of the action (new)
      Comments

      Element Contract.term.action.subject has a context of Contract.term.action based on following the parent source element upwards and mapping to Contract. Element Contract.term.action.subject 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
      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())
      2. Extension.id
      Definition

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

      Shortxml:id (or equivalent in JSON)
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      4. Extension.extension
      Definition

      An Extension

      ShortExtension
      Control1..*
      TypeExtension
      SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 6. Extension.extension:reference
        Slice Namereference
        Definition

        R4: Contract.term.action.subject.reference (new:Reference(Patient,RelatedPerson,Practitioner,PractitionerRole,Device,Group,Organization))

        ShortR4: Entity of the action (new)
        Comments

        Element Contract.term.action.subject.reference is part of an existing definition because parent element Contract.term.action.subject requires a cross-version extension. Element Contract.term.action.subject.reference has a context of Contract.term.action based on following the parent source element upwards and mapping to Contract. Element Contract.term.action.subject.reference has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control1..*
        TypeExtension
        Requirements

        Element Contract.term.action.subject.reference is part of an existing definition because parent element Contract.term.action.subject requires a cross-version extension. Element Contract.term.action.subject.reference has a context of Contract.term.action based on following the parent source element upwards and mapping to Contract. Element Contract.term.action.subject.reference has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        8. Extension.extension:reference.id
        Definition

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

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        10. Extension.extension:reference.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. 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.

        ShortAdditional Content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 12. Extension.extension:reference.url
          Definition

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

          Shortidentifies the meaning of the extension
          Comments

          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

          Control1..1
          Typeuri
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed Valuereference
          14. Extension.extension:reference.value[x]
          Definition

          The entity the action is performed or not performed on or for.

          ShortEntity of the action
          Control1..1
          TypeReference(Cross-version Profile for R4.Patient for use in FHIR STU3, Patient, Cross-version Profile for R4.RelatedPerson for use in FHIR STU3, RelatedPerson, Cross-version Profile for R4.Practitioner for use in FHIR STU3, Practitioner, Cross-version Profile for R4.PractitionerRole for use in FHIR STU3, PractitionerRole, Cross-version Profile for R4.Device for use in FHIR STU3, Device, Cross-version Profile for R4.Group for use in FHIR STU3, Group, Cross-version Profile for R4.Organization for use in FHIR STU3, Organization)
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          16. Extension.extension:role
          Slice Namerole
          Definition

          R4: Contract.term.action.subject.role (new:CodeableConcept)

          ShortR4: Role type of the agent (new)
          Comments

          Element Contract.term.action.subject.role is part of an existing definition because parent element Contract.term.action.subject requires a cross-version extension. Element Contract.term.action.subject.role has a context of Contract.term.action based on following the parent source element upwards and mapping to Contract. Element Contract.term.action.subject.role has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

          Control0..1
          TypeExtension
          Requirements

          Element Contract.term.action.subject.role is part of an existing definition because parent element Contract.term.action.subject requires a cross-version extension. Element Contract.term.action.subject.role has a context of Contract.term.action based on following the parent source element upwards and mapping to Contract. Element Contract.term.action.subject.role has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

          18. Extension.extension:role.id
          Definition

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

          Shortxml:id (or equivalent in JSON)
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          20. Extension.extension:role.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. 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.

          ShortAdditional Content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Alternate Namesextensions, user content
          SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 22. Extension.extension:role.url
            Definition

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

            Shortidentifies the meaning of the extension
            Comments

            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

            Control1..1
            Typeuri
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed Valuerole
            24. Extension.extension:role.value[x]
            Definition

            Role type of agent assigned roles in this Contract.

            ShortRole type of the agent
            Control0..1
            BindingFor example codes, see Contract Actor Role Codes
            (example to http://hl7.org/fhir/ValueSet/contract-actorrole|3.0.2)

            Detailed codes for the contract actor role.

            TypeCodeableConcept
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            26. Extension.url
            Definition

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

            Shortidentifies the meaning of the extension
            Comments

            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

            Control1..1
            Typeuri
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed Valuehttp://hl7.org/fhir/4.0/StructureDefinition/extension-Contract.term.action.subject
            28. Extension.value[x]
            Definition

            Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

            ShortValue of extension
            Control0..0
            TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension