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

Resource Profile: Profile_R4_EnrollmentResponse_R3 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-EnrollmentResponse resource profile.

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

0. EnrollmentResponse
Definition

This resource provides enrollment and plan details from the processing of an Enrollment resource.

ShortEnrollmentResponse resource
Control0..*
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. EnrollmentResponse.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. EnrollmentResponse.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.

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

    R4: EnrollmentResponse.requestProvider

    ShortR4: Responsible practitioner
    Comments

    Element EnrollmentResponse.requestProvider is mapped to FHIR STU3 element EnrollmentResponse.requestProvider as SourceIsBroaderThanTarget. Element EnrollmentResponse.requestProvider is mapped to FHIR STU3 element EnrollmentResponse.requestOrganization as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element EnrollmentResponse.requestProvider with unmapped reference targets: PractitionerRole.

    Control0..1
    TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
    8. EnrollmentResponse.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
    10. EnrollmentResponse.status
    Definition

    The status of the resource instance.

    Shortactive | cancelled | draft | entered-in-error
    Comments

    This element is labeled as a modifier because the status contains codes that mark the response as not currently valid.

    Control0..1
    BindingThe codes SHALL be taken from Financial Resource Status Codeshttp://hl7.org/fhir/ValueSet/fm-status|3.0.2
    (required to http://hl7.org/fhir/ValueSet/fm-status|3.0.2)

    A code specifying the state of the resource instance.

    Typecode
    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

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

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

      R4: EnrollmentResponse.requestProvider

      ShortR4: Responsible practitioner
      Comments

      Element EnrollmentResponse.requestProvider is mapped to FHIR STU3 element EnrollmentResponse.requestProvider as SourceIsBroaderThanTarget. Element EnrollmentResponse.requestProvider is mapped to FHIR STU3 element EnrollmentResponse.requestOrganization as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element EnrollmentResponse.requestProvider with unmapped reference targets: PractitionerRole.

      Control0..1
      TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
      6. EnrollmentResponse.outcome
      8. EnrollmentResponse.outcome.extension
      Control0..*
      SlicingThis element introduces a set of slices on EnrollmentResponse.outcome.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 10. EnrollmentResponse.outcome.extension:outcome
        Slice Nameoutcome
        Definition

        R4: EnrollmentResponse.outcome

        ShortR4: queued | complete | error | partial
        Comments

        Element EnrollmentResponse.outcome is mapped to FHIR STU3 element EnrollmentResponse.outcome as RelatedTo.

        Control0..1
        TypeExtension(R4: queued | complete | error | partial) (Extension Type: code)

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

        0. EnrollmentResponse
        Definition

        This resource provides enrollment and plan details from the processing of an Enrollment resource.

        ShortEnrollmentResponse resource
        Control0..*
        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. EnrollmentResponse.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. EnrollmentResponse.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. EnrollmentResponse.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. EnrollmentResponse.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. EnrollmentResponse.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. EnrollmentResponse.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. EnrollmentResponse.extension
        Definition

        An Extension

        ShortExtension
        Control0..*
        TypeExtension
        SlicingThis element introduces a set of slices on EnrollmentResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 16. EnrollmentResponse.extension:requestProvider
          Slice NamerequestProvider
          Definition

          R4: EnrollmentResponse.requestProvider

          ShortR4: Responsible practitioner
          Comments

          Element EnrollmentResponse.requestProvider is mapped to FHIR STU3 element EnrollmentResponse.requestProvider as SourceIsBroaderThanTarget. Element EnrollmentResponse.requestProvider is mapped to FHIR STU3 element EnrollmentResponse.requestOrganization as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element EnrollmentResponse.requestProvider with unmapped reference targets: PractitionerRole.

          Control0..1
          TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
          18. EnrollmentResponse.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
          20. EnrollmentResponse.identifier
          Definition

          The Response business identifier.

          ShortBusiness Identifier
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          TypeIdentifier
          22. EnrollmentResponse.status
          Definition

          The status of the resource instance.

          Shortactive | cancelled | draft | entered-in-error
          Comments

          This element is labeled as a modifier because the status contains codes that mark the response as not currently valid.

          Control0..1
          BindingThe codes SHALL be taken from Financial Resource Status Codes
          (required to http://hl7.org/fhir/ValueSet/fm-status|3.0.2)

          A code specifying the state of the resource instance.

          Typecode
          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
          24. EnrollmentResponse.request
          Definition

          Original request resource reference.

          ShortClaim reference
          Control0..1
          TypeReference(EnrollmentRequest)
          26. EnrollmentResponse.outcome
          Definition

          Processing status: error, complete.

          Shortcomplete | error | partial
          Control0..1
          BindingThe codes SHALL be taken from Claim Processing Codes .
          (required to http://hl7.org/fhir/ValueSet/remittance-outcome|3.0.2)

          The outcome of the processing.

          TypeCodeableConcept
          28. EnrollmentResponse.outcome.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.
          30. EnrollmentResponse.outcome.extension
          Definition

          An Extension

          ShortExtension
          Control0..*
          TypeExtension
          SlicingThis element introduces a set of slices on EnrollmentResponse.outcome.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 32. EnrollmentResponse.outcome.extension:outcome
            Slice Nameoutcome
            Definition

            R4: EnrollmentResponse.outcome

            ShortR4: queued | complete | error | partial
            Comments

            Element EnrollmentResponse.outcome is mapped to FHIR STU3 element EnrollmentResponse.outcome as RelatedTo.

            Control0..1
            TypeExtension(R4: queued | complete | error | partial) (Extension Type: code)
            34. EnrollmentResponse.outcome.coding
            Definition

            A reference to a code defined by a terminology system.

            ShortCode defined by a terminology system
            Comments

            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

            Control0..*
            TypeCoding
            Summarytrue
            Requirements

            Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

            36. EnrollmentResponse.outcome.text
            Definition

            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

            ShortPlain text representation of the concept
            Comments

            Very often the text is the same as a displayName of one of the codings.

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

            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

            38. EnrollmentResponse.disposition
            Definition

            A description of the status of the adjudication.

            ShortDisposition Message
            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            40. EnrollmentResponse.created
            Definition

            The date when the enclosed suite of services were performed or completed.

            ShortCreation date
            Control0..1
            TypedateTime
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            42. EnrollmentResponse.organization
            Definition

            The Insurer who produced this adjudicated response.

            ShortInsurer
            Control0..1
            TypeReference(Organization)
            44. EnrollmentResponse.requestProvider
            Definition

            The practitioner who is responsible for the services rendered to the patient.

            ShortResponsible practitioner
            Control0..1
            TypeReference(Practitioner)
            46. EnrollmentResponse.requestOrganization
            Definition

            The organization which is responsible for the services rendered to the patient.

            ShortResponsible organization
            Control0..1
            TypeReference(Organization)