Patient Cost Transparency Implementation Guide
2.0.2 - STU 2 United States of America flag

Patient Cost Transparency Implementation Guide, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.0.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pct/ and changes regularly. See the Directory of published versions

Resource Profile: Subscription - AEOB Available for Subject Notification

Official URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-aeob-available-subject-subscription Version: 2.0.2
Standards status: Trial-use Maturity Level: 2 Computable Name: PCTAEOBAvailableSubjectSubscription
Other Identifiers: OID:2.16.840.1.113883.4.642.40.4.42.64

A subject focused Subscription when an Advanced Explanation of Benefit (AEOB) Packet DocumentReference is created or updated (for FHIR R4). This represents that an AEOB Bundle, either contained in or referred to by the DocumentReference has been newly created and is available or has been updated, should updates be made.

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 1.1.0:

  • New Content

    • Formal Views of Profile Content

    Description Differentials, Snapshots, and other representations.

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Subscription 0..* Subscription Server push subscription criteria
    Subscription.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Subscription.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Subscription.status This element is a modifier element. This element is included in summaries. 1..1 code requested | active | error | off
    Binding: SubscriptionStatus (required): The status of a subscription.
    Required Pattern: active (extensions allowed)
    Subscription.reason This element is included in summaries. 1..1 string Description of why this subscription was created
    Subscription.criteria This element is included in summaries. 1..1 string Rule for server push
    Required Pattern: http://hl7.org/fhir/us/davinci-pct/SubscriptionTopic/davinci-pct-aeob-available-subject-notification (extensions allowed)
    Subscription.criteria.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.criteria.Slices for extension.extension:filterCriteria This element must be supported. 1..* string Backported R5 FilterBy Criteria
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
    Subscription.channel This element is included in summaries. 1..1 BackboneElement The channel on which to report matches to the criteria
    Subscription.channel.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.channel.Slices for extension.extension:heartbeatPeriod 0..1 unsignedInt Backport R5 Subscription Heartbeat Period
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
    Subscription.channel.Slices for extension.extension:timeout 0..1 unsignedInt Backport R5 Subscription Timeout
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
    Subscription.channel.Slices for extension.extension:maxCount 0..1 positiveInt Backported R5 Subscription MaxCount
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
    Subscription.channel.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Subscription.channel.type This element is included in summaries. 1..1 code rest-hook | websocket | email | sms | message
    Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
    Subscription.channel.payload This element is included in summaries. 0..1 code MIME type to send, or omit for no payload
    Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
    Subscription.channel.payload.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.channel.payload.Slices for extension.extension:payloadContent This element must be supported. 1..1 code Backport R5 Subscription Payload Content Information
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
    Binding: Backported R5 Subscription Content Value Set (required)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Subscription.status Base required SubscriptionStatus 📍4.0.1 FHIR Std.
    Subscription.channel.​type Base required SubscriptionChannelType 📍4.0.1 FHIR Std.
    Subscription.channel.​payload Base required MimeType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression

    This structure is derived from Subscription

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Subscription 0..* Subscription Server push subscription criteria
    Subscription.status 1..1 code requested | active | error | off
    Required Pattern: active (extensions allowed)
    Subscription.criteria 1..1 string Rule for server push
    Required Pattern: http://hl7.org/fhir/us/davinci-pct/SubscriptionTopic/davinci-pct-aeob-available-subject-notification (extensions allowed)
    Subscription.criteria.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.criteria.Slices for extension.extension:filterCriteria This element must be supported. 1..* string Backported R5 FilterBy Criteria
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
    Subscription.channel
    Subscription.channel.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.channel.Slices for extension.extension:heartbeatPeriod 0..1 unsignedInt Backport R5 Subscription Heartbeat Period
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
    Subscription.channel.Slices for extension.extension:timeout 0..1 unsignedInt Backport R5 Subscription Timeout
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
    Subscription.channel.Slices for extension.extension:maxCount 0..1 positiveInt Backported R5 Subscription MaxCount
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
    Subscription.channel.payload
    Subscription.channel.payload.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.channel.payload.Slices for extension.extension:payloadContent This element must be supported. 1..1 code Backport R5 Subscription Payload Content Information
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
    Binding: Backported R5 Subscription Content Value Set (required)

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Subscription 0..* Subscription Server push subscription criteria
    Subscription.id This element is included in summaries. 0..1 id Logical id of this artifact
    Subscription.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Subscription.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Subscription.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Subscription.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    Subscription.contained 0..* Resource Contained, inline Resources
    Subscription.extension 0..* Extension Additional content defined by implementations
    Subscription.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Subscription.status This element is a modifier element. This element is included in summaries. 1..1 code requested | active | error | off
    Binding: SubscriptionStatus (required): The status of a subscription.
    Required Pattern: active (extensions allowed)
    Subscription.contact This element is included in summaries. 0..* ContactPoint Contact details for source (e.g. troubleshooting)
    Subscription.end This element is included in summaries. 0..1 instant When to automatically delete the subscription
    Subscription.reason This element is included in summaries. 1..1 string Description of why this subscription was created
    Subscription.criteria This element is included in summaries. 1..1 string Rule for server push
    Required Pattern: http://hl7.org/fhir/us/davinci-pct/SubscriptionTopic/davinci-pct-aeob-available-subject-notification (extensions allowed)
    Subscription.criteria.id 0..1 string xml:id (or equivalent in JSON)
    Subscription.criteria.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.criteria.Slices for extension.extension:filterCriteria This element must be supported. 1..* string Backported R5 FilterBy Criteria
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
    Subscription.criteria.value 0..1 string Primitive value for string
    Max Length:1048576
    Subscription.error This element is included in summaries. 0..1 string Latest error note
    Subscription.channel This element is included in summaries. 1..1 BackboneElement The channel on which to report matches to the criteria
    Subscription.channel.id 0..1 string Unique id for inter-element referencing
    Subscription.channel.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.channel.Slices for extension.extension:heartbeatPeriod 0..1 unsignedInt Backport R5 Subscription Heartbeat Period
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
    Subscription.channel.Slices for extension.extension:timeout 0..1 unsignedInt Backport R5 Subscription Timeout
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
    Subscription.channel.Slices for extension.extension:maxCount 0..1 positiveInt Backported R5 Subscription MaxCount
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
    Subscription.channel.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Subscription.channel.type This element is included in summaries. 1..1 code rest-hook | websocket | email | sms | message
    Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
    Subscription.channel.endpoint This element is included in summaries. 0..1 url Where the channel points to
    Subscription.channel.payload This element is included in summaries. 0..1 code MIME type to send, or omit for no payload
    Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
    Subscription.channel.payload.id 0..1 string xml:id (or equivalent in JSON)
    Subscription.channel.payload.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.channel.payload.Slices for extension.extension:payloadContent This element must be supported. 1..1 code Backport R5 Subscription Payload Content Information
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
    Binding: Backported R5 Subscription Content Value Set (required)
    Subscription.channel.payload.value 0..1 string Primitive value for code
    Subscription.channel.header This element is included in summaries. 0..* string Usage depends on the channel type

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Subscription.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Subscription.status Base required SubscriptionStatus 📍4.0.1 FHIR Std.
    Subscription.channel.​type Base required SubscriptionChannelType 📍4.0.1 FHIR Std.
    Subscription.channel.​payload Base required MimeType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Subscription 0..* Subscription Server push subscription criteria
    Subscription.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Subscription.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Subscription.status This element is a modifier element. This element is included in summaries. 1..1 code requested | active | error | off
    Binding: SubscriptionStatus (required): The status of a subscription.
    Required Pattern: active (extensions allowed)
    Subscription.reason This element is included in summaries. 1..1 string Description of why this subscription was created
    Subscription.criteria This element is included in summaries. 1..1 string Rule for server push
    Required Pattern: http://hl7.org/fhir/us/davinci-pct/SubscriptionTopic/davinci-pct-aeob-available-subject-notification (extensions allowed)
    Subscription.criteria.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.criteria.Slices for extension.extension:filterCriteria This element must be supported. 1..* string Backported R5 FilterBy Criteria
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
    Subscription.channel This element is included in summaries. 1..1 BackboneElement The channel on which to report matches to the criteria
    Subscription.channel.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.channel.Slices for extension.extension:heartbeatPeriod 0..1 unsignedInt Backport R5 Subscription Heartbeat Period
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
    Subscription.channel.Slices for extension.extension:timeout 0..1 unsignedInt Backport R5 Subscription Timeout
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
    Subscription.channel.Slices for extension.extension:maxCount 0..1 positiveInt Backported R5 Subscription MaxCount
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
    Subscription.channel.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Subscription.channel.type This element is included in summaries. 1..1 code rest-hook | websocket | email | sms | message
    Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
    Subscription.channel.payload This element is included in summaries. 0..1 code MIME type to send, or omit for no payload
    Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
    Subscription.channel.payload.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.channel.payload.Slices for extension.extension:payloadContent This element must be supported. 1..1 code Backport R5 Subscription Payload Content Information
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
    Binding: Backported R5 Subscription Content Value Set (required)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Subscription.status Base required SubscriptionStatus 📍4.0.1 FHIR Std.
    Subscription.channel.​type Base required SubscriptionChannelType 📍4.0.1 FHIR Std.
    Subscription.channel.​payload Base required MimeType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression

    Differential View

    This structure is derived from Subscription

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Subscription 0..* Subscription Server push subscription criteria
    Subscription.status 1..1 code requested | active | error | off
    Required Pattern: active (extensions allowed)
    Subscription.criteria 1..1 string Rule for server push
    Required Pattern: http://hl7.org/fhir/us/davinci-pct/SubscriptionTopic/davinci-pct-aeob-available-subject-notification (extensions allowed)
    Subscription.criteria.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.criteria.Slices for extension.extension:filterCriteria This element must be supported. 1..* string Backported R5 FilterBy Criteria
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
    Subscription.channel
    Subscription.channel.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.channel.Slices for extension.extension:heartbeatPeriod 0..1 unsignedInt Backport R5 Subscription Heartbeat Period
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
    Subscription.channel.Slices for extension.extension:timeout 0..1 unsignedInt Backport R5 Subscription Timeout
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
    Subscription.channel.Slices for extension.extension:maxCount 0..1 positiveInt Backported R5 Subscription MaxCount
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
    Subscription.channel.payload
    Subscription.channel.payload.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.channel.payload.Slices for extension.extension:payloadContent This element must be supported. 1..1 code Backport R5 Subscription Payload Content Information
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
    Binding: Backported R5 Subscription Content Value Set (required)

    doco Documentation for this format

    Snapshot ViewView

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Subscription 0..* Subscription Server push subscription criteria
    Subscription.id This element is included in summaries. 0..1 id Logical id of this artifact
    Subscription.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Subscription.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Subscription.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Subscription.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    Subscription.contained 0..* Resource Contained, inline Resources
    Subscription.extension 0..* Extension Additional content defined by implementations
    Subscription.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Subscription.status This element is a modifier element. This element is included in summaries. 1..1 code requested | active | error | off
    Binding: SubscriptionStatus (required): The status of a subscription.
    Required Pattern: active (extensions allowed)
    Subscription.contact This element is included in summaries. 0..* ContactPoint Contact details for source (e.g. troubleshooting)
    Subscription.end This element is included in summaries. 0..1 instant When to automatically delete the subscription
    Subscription.reason This element is included in summaries. 1..1 string Description of why this subscription was created
    Subscription.criteria This element is included in summaries. 1..1 string Rule for server push
    Required Pattern: http://hl7.org/fhir/us/davinci-pct/SubscriptionTopic/davinci-pct-aeob-available-subject-notification (extensions allowed)
    Subscription.criteria.id 0..1 string xml:id (or equivalent in JSON)
    Subscription.criteria.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.criteria.Slices for extension.extension:filterCriteria This element must be supported. 1..* string Backported R5 FilterBy Criteria
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
    Subscription.criteria.value 0..1 string Primitive value for string
    Max Length:1048576
    Subscription.error This element is included in summaries. 0..1 string Latest error note
    Subscription.channel This element is included in summaries. 1..1 BackboneElement The channel on which to report matches to the criteria
    Subscription.channel.id 0..1 string Unique id for inter-element referencing
    Subscription.channel.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.channel.Slices for extension.extension:heartbeatPeriod 0..1 unsignedInt Backport R5 Subscription Heartbeat Period
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
    Subscription.channel.Slices for extension.extension:timeout 0..1 unsignedInt Backport R5 Subscription Timeout
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
    Subscription.channel.Slices for extension.extension:maxCount 0..1 positiveInt Backported R5 Subscription MaxCount
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
    Subscription.channel.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Subscription.channel.type This element is included in summaries. 1..1 code rest-hook | websocket | email | sms | message
    Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
    Subscription.channel.endpoint This element is included in summaries. 0..1 url Where the channel points to
    Subscription.channel.payload This element is included in summaries. 0..1 code MIME type to send, or omit for no payload
    Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
    Subscription.channel.payload.id 0..1 string xml:id (or equivalent in JSON)
    Subscription.channel.payload.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    Subscription.channel.payload.Slices for extension.extension:payloadContent This element must be supported. 1..1 code Backport R5 Subscription Payload Content Information
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
    Binding: Backported R5 Subscription Content Value Set (required)
    Subscription.channel.payload.value 0..1 string Primitive value for code
    Subscription.channel.header This element is included in summaries. 0..* string Usage depends on the channel type

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Subscription.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Subscription.status Base required SubscriptionStatus 📍4.0.1 FHIR Std.
    Subscription.channel.​type Base required SubscriptionChannelType 📍4.0.1 FHIR Std.
    Subscription.channel.​payload Base required MimeType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression

     

    Other representations of profile: CSV, Excel, Schematron