Publish Box goes here
Resource Profile: Profile - Athena Subscription
| Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-profile | Version: 23.1.0 | |||
| Active as of 2022-03-01 | Computable Name: AthenaSubscription | |||
athena-subscription-profile
This Subscription profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read, search, create and update capabilities of these products.
Overview
The subscription resource is used to define a push-based subscription from a server to another system.
Scope and Usage
Once a subscription is created, any newly created or updated resources that meet the criteria in the resource cause a notification to be sent using the provided channel. The criteria are Search strings that have the same interpretation as if they were appended to the base URL and submitted using the REST API.
This profile is used to define the content that will be returned by the API Server in response to requests to access Subscription resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
Source
The Subscription resource is used to access or create subscriptions. Content of the resource derives from the SUBSCRIPTION table in athenaPractice and athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.
Usage:
- This Resource Profile is not used by any profiles in this Implementation Guide
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Subscription
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Subscription |
0..* | Subscription | Server push subscription criteria | |
  id |
S | 0..1 | id | Logical id of this artifact |
  meta |
0..1 | Meta | Metadata about the resource | |
 lastUpdated |
1..1 | instant | When the resource version last changed | |
| profile |
1..* | canonical() | Profiles this resource claims to conform to | |
 security |
S | 0..1 | Coding | Security Labels applied to this resource |
 Slices for extension |
Content/Rules for all slices | |||
  OWNER |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-owner |
  url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-owner" | |
  value[x] |
1..1 | Reference(Practitioner) | Value of extension | |
| SOURCEID |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-id |
| url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-id" | |
| value[x] |
1..1 | string | Value of extension | |
 SOURCENAME |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-name |
 url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-name" | |
| value[x] |
1..1 | string | Value of extension | |
| status |
S | 1..1 | code | requested | active | error | off |
| Slices for contact |
0..* | ContactPoint | Contact details for source (e.g. troubleshooting) Slice: Unordered, Open by value:system | |
| contact:PHONE |
0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) | |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value |
1..1 | string | The actual contact point details | |
| contact:CONTACTEMAIL |
0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) | |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email | |
| value |
1..1 | string | The actual contact point details | |
| 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 | |
| error |
0..1 | string | Latest error note | |
  channel |
1..1 | BackboneElement | The channel on which to report matches to the criteria | |
| type |
1..1 | code | rest-hook | websocket | email | sms | message Fixed Value: rest-hook | |
| endpoint |
0..1 | url | Where the channel points to | |
| header |
0..1 | string | Usage depends on the channel type | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Subscription |
0..* | Subscription | Server push subscription criteria | |
| id |
SΣ | 0..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| lastUpdated |
Σ | 1..1 | instant | When the resource version last changed |
| profile |
Σ | 1..* | canonical() | Profiles this resource claims to conform to |
| security |
SΣ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| OWNER |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-owner |
| url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-owner" | |
| value[x] |
1..1 | Reference(Practitioner) | Value of extension | |
| SOURCEID |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-id |
| url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-id" | |
| value[x] |
1..1 | string | Value of extension | |
| SOURCENAME |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-name |
| url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-name" | |
| value[x] |
1..1 | string | Value of extension | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. |
| Slices for contact |
Σ | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) Slice: Unordered, Open by value:system |
| contact:PHONE |
Σ | 0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) |
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
| value |
Σ | 1..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| contact:CONTACTEMAIL |
Σ | 0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) |
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
| value |
Σ | 1..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| 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 |
| error |
Σ | 0..1 | string | Latest error note |
| 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. Fixed Value: rest-hook |
| endpoint |
Σ | 0..1 | url | Where the channel points to |
| header |
Σ | 0..1 | string | Usage depends on the channel type |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| Subscription.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Subscription.status | required | SubscriptionStatushttp://hl7.org/fhir/ValueSet/subscription-status|4.0.1from the FHIR Standard | |
| Subscription.contact:PHONE.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| Subscription.contact:PHONE.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | |
| Subscription.contact:CONTACTEMAIL.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| Subscription.contact:CONTACTEMAIL.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | |
| Subscription.channel.type | required | Fixed Value: rest-hookhttp://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Subscription |
0..* | Subscription | Server push subscription criteria | |||||
| id |
SΣ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 1..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 1..* | canonical() | Profiles this resource claims to conform to | ||||
| security |
SΣ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| OWNER |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-owner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-owner" | |||||
| value[x] |
1..1 | Reference(Practitioner) | Value of extension | |||||
| SOURCEID |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-id | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-id" | |||||
| value[x] |
1..1 | string | Value of extension | |||||
| SOURCENAME |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-name | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-name" | |||||
| value[x] |
1..1 | string | Value of extension | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| status |
?!SΣ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. | ||||
| Slices for contact |
Σ | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) Slice: Unordered, Open by value:system | ||||
| contact:PHONE |
Σ | 0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value |
Σ | 1..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| contact:CONTACTEMAIL |
Σ | 0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
| value |
Σ | 1..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| 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 | ||||
| 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. Fixed Value: rest-hook | ||||
| 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. | ||||
| header |
Σ | 0..1 | string | Usage depends on the channel type | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| Subscription.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Subscription.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Subscription.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Subscription.status | required | SubscriptionStatushttp://hl7.org/fhir/ValueSet/subscription-status|4.0.1from the FHIR Standard | ||||
| Subscription.contact:PHONE.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Subscription.contact:PHONE.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Subscription.contact:CONTACTEMAIL.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Subscription.contact:CONTACTEMAIL.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Subscription.channel.type | required | Fixed Value: rest-hookhttp://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1from the FHIR Standard | ||||
| Subscription.channel.payload | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
This structure is derived from Subscription
Summary
Mandatory: 5 elements(12 nested mandatory elements)
Must-Support: 6 elements
Fixed: 6 elements
Extensions
This structure refers to these extensions:
- https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-owner
- https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-id
- https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-name
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Subscription.contact
Differential View
This structure is derived from Subscription
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Subscription |
0..* | Subscription | Server push subscription criteria | |
| id |
S | 0..1 | id | Logical id of this artifact |
| meta |
0..1 | Meta | Metadata about the resource | |
| lastUpdated |
1..1 | instant | When the resource version last changed | |
| profile |
1..* | canonical() | Profiles this resource claims to conform to | |
| security |
S | 0..1 | Coding | Security Labels applied to this resource |
| Slices for extension |
Content/Rules for all slices | |||
| OWNER |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-owner |
| url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-owner" | |
| value[x] |
1..1 | Reference(Practitioner) | Value of extension | |
| SOURCEID |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-id |
| url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-id" | |
| value[x] |
1..1 | string | Value of extension | |
| SOURCENAME |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-name |
| url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-name" | |
| value[x] |
1..1 | string | Value of extension | |
| status |
S | 1..1 | code | requested | active | error | off |
| Slices for contact |
0..* | ContactPoint | Contact details for source (e.g. troubleshooting) Slice: Unordered, Open by value:system | |
| contact:PHONE |
0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) | |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value |
1..1 | string | The actual contact point details | |
| contact:CONTACTEMAIL |
0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) | |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email | |
| value |
1..1 | string | The actual contact point details | |
| 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 | |
| error |
0..1 | string | Latest error note | |
| channel |
1..1 | BackboneElement | The channel on which to report matches to the criteria | |
| type |
1..1 | code | rest-hook | websocket | email | sms | message Fixed Value: rest-hook | |
| endpoint |
0..1 | url | Where the channel points to | |
| header |
0..1 | string | Usage depends on the channel type | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Subscription |
0..* | Subscription | Server push subscription criteria | |
| id |
SΣ | 0..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| lastUpdated |
Σ | 1..1 | instant | When the resource version last changed |
| profile |
Σ | 1..* | canonical() | Profiles this resource claims to conform to |
| security |
SΣ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| OWNER |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-owner |
| url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-owner" | |
| value[x] |
1..1 | Reference(Practitioner) | Value of extension | |
| SOURCEID |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-id |
| url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-id" | |
| value[x] |
1..1 | string | Value of extension | |
| SOURCENAME |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-name |
| url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-name" | |
| value[x] |
1..1 | string | Value of extension | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. |
| Slices for contact |
Σ | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) Slice: Unordered, Open by value:system |
| contact:PHONE |
Σ | 0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) |
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
| value |
Σ | 1..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| contact:CONTACTEMAIL |
Σ | 0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) |
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
| value |
Σ | 1..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| 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 |
| error |
Σ | 0..1 | string | Latest error note |
| 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. Fixed Value: rest-hook |
| endpoint |
Σ | 0..1 | url | Where the channel points to |
| header |
Σ | 0..1 | string | Usage depends on the channel type |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| Subscription.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Subscription.status | required | SubscriptionStatushttp://hl7.org/fhir/ValueSet/subscription-status|4.0.1from the FHIR Standard | |
| Subscription.contact:PHONE.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| Subscription.contact:PHONE.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | |
| Subscription.contact:CONTACTEMAIL.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| Subscription.contact:CONTACTEMAIL.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | |
| Subscription.channel.type | required | Fixed Value: rest-hookhttp://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Subscription |
0..* | Subscription | Server push subscription criteria | |||||
| id |
SΣ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 1..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 1..* | canonical() | Profiles this resource claims to conform to | ||||
| security |
SΣ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| OWNER |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-owner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-owner" | |||||
| value[x] |
1..1 | Reference(Practitioner) | Value of extension | |||||
| SOURCEID |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-id | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-id" | |||||
| value[x] |
1..1 | string | Value of extension | |||||
| SOURCENAME |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-name | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-name" | |||||
| value[x] |
1..1 | string | Value of extension | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| status |
?!SΣ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. | ||||
| Slices for contact |
Σ | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) Slice: Unordered, Open by value:system | ||||
| contact:PHONE |
Σ | 0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value |
Σ | 1..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| contact:CONTACTEMAIL |
Σ | 0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
| value |
Σ | 1..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| 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 | ||||
| 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. Fixed Value: rest-hook | ||||
| 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. | ||||
| header |
Σ | 0..1 | string | Usage depends on the channel type | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| Subscription.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Subscription.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Subscription.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Subscription.status | required | SubscriptionStatushttp://hl7.org/fhir/ValueSet/subscription-status|4.0.1from the FHIR Standard | ||||
| Subscription.contact:PHONE.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Subscription.contact:PHONE.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Subscription.contact:CONTACTEMAIL.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Subscription.contact:CONTACTEMAIL.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Subscription.channel.type | required | Fixed Value: rest-hookhttp://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1from the FHIR Standard | ||||
| Subscription.channel.payload | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
This structure is derived from Subscription
Summary
Mandatory: 5 elements(12 nested mandatory elements)
Must-Support: 6 elements
Fixed: 6 elements
Extensions
This structure refers to these extensions:
- https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-owner
- https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-id
- https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-subscription-extension-source-name
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Subscription.contact
Other representations of profile: CSV, Excel, Schematron
Notes:
Supported Interactions
The Interactions supported by this resource are listed below.
Search Parameters
Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Subscription resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.
GET [base]/fhir/R4/Subscription?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}
Where:
| Name | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [_count] | Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results Subscription resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Virence Partner program. Note: The API Server support the HL7 FHIR Paging capability. |
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
| [_summary] | Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets. |
| _id (token) | The ID of the resource |
| _lastUpdated (date) | |
| _lastUpdated-fromnow (quantity) | Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time, e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| contact (token) | Contact details for the subscription. |
| criteria (string) | The search rules used to determine when to send a notification. |
| status (token) | The current state of the subscription. |
| type (token) | The type of channel for the sent notifications |
| url (uri) | The uri that will receive the notifications |
HTTP Response Codes
The following HTTP response codes are returned by this API call:
| 200 OK | The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |