Extensions for Using Data Elements from FHIR R4 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| 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. |
| Short | EnrollmentResponse resource |
| Control | 0..* |
| Invariants | 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())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. |
| Short | A 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Short | ExtensionAdditional 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on EnrollmentResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. EnrollmentResponse.extension:requestProvider | |
| Slice Name | requestProvider |
| Definition | R4: |
| Short | R4: Responsible practitioner |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(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. |
| Short | Extensions 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Alternate Names | extensions, user content |
| 10. EnrollmentResponse.status | |
| Definition | The status of the resource instance. |
| Short | active | 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. |
| Control | 0..1 |
| Binding | The 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. |
| Type | code |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
Guidance on how to interpret the contents of this table can be foundhere
| 0. EnrollmentResponse | |
| 2. EnrollmentResponse.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on EnrollmentResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. EnrollmentResponse.extension:requestProvider | |
| Slice Name | requestProvider |
| Definition | R4: |
| Short | R4: Responsible practitioner |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 6. EnrollmentResponse.outcome | |
| 8. EnrollmentResponse.outcome.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on EnrollmentResponse.outcome.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 10. EnrollmentResponse.outcome.extension:outcome | |
| Slice Name | outcome |
| Definition | R4: |
| Short | R4: queued | complete | error | partial |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(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. | ||||
| Short | EnrollmentResponse resource | ||||
| Control | 0..* | ||||
| Invariants | 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.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical 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. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 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. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Summary | true | ||||
| 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. | ||||
| Short | A 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. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 8. EnrollmentResponse.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language 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). | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This 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. | ||||
| Short | Text 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. | ||||
| Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, 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. | ||||
| Short | Contained, 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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. EnrollmentResponse.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on EnrollmentResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. EnrollmentResponse.extension:requestProvider | |||||
| Slice Name | requestProvider | ||||
| Definition | R4: | ||||
| Short | R4: Responsible practitioner | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(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. | ||||
| Short | Extensions 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Alternate Names | extensions, user content | ||||
| 20. EnrollmentResponse.identifier | |||||
| Definition | The Response business identifier. | ||||
| Short | Business Identifier | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| 22. EnrollmentResponse.status | |||||
| Definition | The status of the resource instance. | ||||
| Short | active | 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. | ||||
| Control | 0..1 | ||||
| Binding | The 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. | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 24. EnrollmentResponse.request | |||||
| Definition | Original request resource reference. | ||||
| Short | Claim reference | ||||
| Control | 0..1 | ||||
| Type | Reference(EnrollmentRequest) | ||||
| 26. EnrollmentResponse.outcome | |||||
| Definition | Processing status: error, complete. | ||||
| Short | complete | error | partial | ||||
| Control | 0..1 | ||||
| Binding | The 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. | ||||
| Type | CodeableConcept | ||||
| 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. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 30. EnrollmentResponse.outcome.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on EnrollmentResponse.outcome.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 32. EnrollmentResponse.outcome.extension:outcome | |||||
| Slice Name | outcome | ||||
| Definition | R4: | ||||
| Short | R4: queued | complete | error | partial | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R4: queued | complete | error | partial) (Extension Type: code) | ||||
| 34. EnrollmentResponse.outcome.coding | |||||
| Definition | A reference to a code defined by a terminology system. | ||||
| Short | Code 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. | ||||
| Control | 0..* | ||||
| Type | Coding | ||||
| Summary | true | ||||
| 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. | ||||
| Short | Plain text representation of the concept | ||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 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. | ||||
| Short | Disposition Message | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This 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. | ||||
| Short | Creation date | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 42. EnrollmentResponse.organization | |||||
| Definition | The Insurer who produced this adjudicated response. | ||||
| Short | Insurer | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| 44. EnrollmentResponse.requestProvider | |||||
| Definition | The practitioner who is responsible for the services rendered to the patient. | ||||
| Short | Responsible practitioner | ||||
| Control | 0..1 | ||||
| Type | Reference(Practitioner) | ||||
| 46. EnrollmentResponse.requestOrganization | |||||
| Definition | The organization which is responsible for the services rendered to the patient. | ||||
| Short | Responsible organization | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||