Patient Cost Transparency Implementation Guide
2.0.0 - 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.0 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 - GFE Available for Author Notification

Official URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-gfe-available-author-subscription Version: 2.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: PCTGFEAvailableAuthorSubscription
Other Identifiers: OID:2.16.840.1.113883.4.642.40.4.42.65

An author focused Subscription when a Good Faith Estimate (GFE) Packet DocumentReference is created or updated (for FHIR R4). This represents that a GFE 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 of Profiles, Differentials, Snapshots and how the different presentations work.

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Subscription 0..* Subscription Server push subscription criteria
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... status ?!Σ 1..1 code requested | active | error | off
    Binding: SubscriptionStatus (required): The status of a subscription.
    Required Pattern: active
    ... reason Σ 1..1 string Description of why this subscription was created
    ... criteria Σ 1..1 string Rule for server push
    Required Pattern: http://hl7.org/fhir/us/davinci-pct/SubscriptionTopic/davinci-pct-gfe-available-author-notification
    .... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ..... extension:filterCriteria S 1..* string Backported R5 FilterBy Criteria
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
    ... channel Σ 1..1 BackboneElement The channel on which to report matches to the criteria
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... type Σ 1..1 code rest-hook | websocket | email | sms | message
    Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
    .... payload Σ 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.
    ..... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:payloadContent S 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
    dom-2 error Subscription If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Subscription If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error Subscription 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-5 error Subscription If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Subscription A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    This structure is derived from Subscription

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Subscription 0..* Subscription Server push subscription criteria
    ... status 1..1 code requested | active | error | off
    Required Pattern: active
    ... criteria 1..1 string Rule for server push
    Required Pattern: http://hl7.org/fhir/us/davinci-pct/SubscriptionTopic/davinci-pct-gfe-available-author-notification
    .... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ..... extension:filterCriteria S 1..* string Backported R5 FilterBy Criteria
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
    ... channel
    .... payload
    ..... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:payloadContent S 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: Filtersdoco
    .. Subscription 0..* Subscription Server push subscription criteria
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    ... 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
    ... contained 0..* Resource Contained, inline Resources
    ... extension 0..* Extension Additional content defined by implementations
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... status ?!Σ 1..1 code requested | active | error | off
    Binding: SubscriptionStatus (required): The status of a subscription.
    Required Pattern: active
    ... contact Σ 0..* ContactPoint Contact details for source (e.g. troubleshooting)
    ... end Σ 0..1 instant When to automatically delete the subscription
    ... reason Σ 1..1 string Description of why this subscription was created
    ... criteria Σ 1..1 string Rule for server push
    Required Pattern: http://hl7.org/fhir/us/davinci-pct/SubscriptionTopic/davinci-pct-gfe-available-author-notification
    .... id 0..1 string xml:id (or equivalent in JSON)
    .... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ..... extension:filterCriteria S 1..* string Backported R5 FilterBy Criteria
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
    .... value 0..1 string Primitive value for string
    Max Length:1048576
    ... error Σ 0..1 string Latest error note
    ... channel Σ 1..1 BackboneElement The channel on which to report matches to the criteria
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... type Σ 1..1 code rest-hook | websocket | email | sms | message
    Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
    .... endpoint Σ 0..1 url Where the channel points to
    .... payload Σ 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.
    ..... id 0..1 string xml:id (or equivalent in JSON)
    ..... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:payloadContent S 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)
    ..... value 0..1 string Primitive value for code
    .... header Σ 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
    dom-2 error Subscription If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Subscription If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error Subscription 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-5 error Subscription If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Subscription A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    This structure is derived from Subscription

    Summary

    Mandatory: 2 elements(2 nested mandatory elements)
    Must-Support: 2 elements

    Extensions

    This structure refers to these extensions:

    Maturity: 2

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Subscription 0..* Subscription Server push subscription criteria
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... status ?!Σ 1..1 code requested | active | error | off
    Binding: SubscriptionStatus (required): The status of a subscription.
    Required Pattern: active
    ... reason Σ 1..1 string Description of why this subscription was created
    ... criteria Σ 1..1 string Rule for server push
    Required Pattern: http://hl7.org/fhir/us/davinci-pct/SubscriptionTopic/davinci-pct-gfe-available-author-notification
    .... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ..... extension:filterCriteria S 1..* string Backported R5 FilterBy Criteria
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
    ... channel Σ 1..1 BackboneElement The channel on which to report matches to the criteria
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... type Σ 1..1 code rest-hook | websocket | email | sms | message
    Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
    .... payload Σ 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.
    ..... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:payloadContent S 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
    dom-2 error Subscription If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Subscription If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error Subscription 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-5 error Subscription If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Subscription A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    Differential View

    This structure is derived from Subscription

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Subscription 0..* Subscription Server push subscription criteria
    ... status 1..1 code requested | active | error | off
    Required Pattern: active
    ... criteria 1..1 string Rule for server push
    Required Pattern: http://hl7.org/fhir/us/davinci-pct/SubscriptionTopic/davinci-pct-gfe-available-author-notification
    .... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ..... extension:filterCriteria S 1..* string Backported R5 FilterBy Criteria
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
    ... channel
    .... payload
    ..... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:payloadContent S 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 View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Subscription 0..* Subscription Server push subscription criteria
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    ... 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
    ... contained 0..* Resource Contained, inline Resources
    ... extension 0..* Extension Additional content defined by implementations
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... status ?!Σ 1..1 code requested | active | error | off
    Binding: SubscriptionStatus (required): The status of a subscription.
    Required Pattern: active
    ... contact Σ 0..* ContactPoint Contact details for source (e.g. troubleshooting)
    ... end Σ 0..1 instant When to automatically delete the subscription
    ... reason Σ 1..1 string Description of why this subscription was created
    ... criteria Σ 1..1 string Rule for server push
    Required Pattern: http://hl7.org/fhir/us/davinci-pct/SubscriptionTopic/davinci-pct-gfe-available-author-notification
    .... id 0..1 string xml:id (or equivalent in JSON)
    .... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ..... extension:filterCriteria S 1..* string Backported R5 FilterBy Criteria
    URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
    .... value 0..1 string Primitive value for string
    Max Length:1048576
    ... error Σ 0..1 string Latest error note
    ... channel Σ 1..1 BackboneElement The channel on which to report matches to the criteria
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... type Σ 1..1 code rest-hook | websocket | email | sms | message
    Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
    .... endpoint Σ 0..1 url Where the channel points to
    .... payload Σ 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.
    ..... id 0..1 string xml:id (or equivalent in JSON)
    ..... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:payloadContent S 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)
    ..... value 0..1 string Primitive value for code
    .... header Σ 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
    dom-2 error Subscription If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Subscription If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error Subscription 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-5 error Subscription If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Subscription A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    This structure is derived from Subscription

    Summary

    Mandatory: 2 elements(2 nested mandatory elements)
    Must-Support: 2 elements

    Extensions

    This structure refers to these extensions:

    Maturity: 2

     

    Other representations of profile: CSV, Excel, Schematron