Subscription - FHIR Resource (dstu2)

This Subscription Resource uses the FHIR API standard for access and structure.

Validate an Subscription FHIR Resource (dstu2)

Subscription Attributes

AttributeField is listTypeDescription

Description: requested | active | error | off

FHIR Version: dstu2

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status":

Learn more about the (Subscription) status FHIR attribute

Description: When to automatically delete the subscription

FHIR Version: dstu2

Attribute Type : instant

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"end":

Learn more about the (Subscription) end FHIR attribute

Description: Latest error note

FHIR Version: dstu2

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"error":

Learn more about the (Subscription) error FHIR attribute

Description: Contact details for source (e.g. troubleshooting)

FHIR Version: dstu2

Attribute Type : ContactPoint

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"contact":

Learn more about the (Subscription) contact FHIR attribute

Description: Description of why this subscription was created

FHIR Version: dstu2

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"reason":

Learn more about the (Subscription) reason FHIR attribute

Description: A tag to add to matching resources

FHIR Version: dstu2

Attribute Type : Coding

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"tag":

Learn more about the (Subscription) tag FHIR attribute

Description: Rule for server push criteria

FHIR Version: dstu2

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"criteria":

Learn more about the (Subscription) criteria FHIR attribute

Description: The channel on which to report matches to the criteria

FHIR Version: dstu2

Attribute Type : Data Type

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"channel":

Learn more about the (Subscription) channel FHIR attribute

Subscription Structure


  
{
  "resourceType" : "Subscription",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "criteria" : "<string>", // R!  Rule for server push criteria
  "contact" : [{ ContactPoint }], // Contact details for source (e.g. troubleshooting)
  "reason" : "<string>", // R!  Description of why this subscription was created
  "status" : "<code>", // R!  requested | active | error | off
  "error" : "<string>", // Latest error note
  "channel" : { // R!  The channel on which to report matches to the criteria
    "type" : "<code>", // R!  rest-hook | websocket | email | sms | message
    "endpoint" : "<uri>", // Where the channel points to
    "payload" : "<string>", // R!  Mimetype to send, or blank for no payload
    "header" : "<string>" // Usage depends on the channel type
  },
  "end" : "<instant>", // When to automatically delete the subscription
  "tag" : [{ Coding }] // A tag to add to matching resources
}

Subscription Search Parameters

The following search parameters can be used to query Subscription resources. Just submit them like so:

https://api.1up.health/fhir/dstu2/Subscription?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`contact`	`text`	`contact`
`criteria`	`text`	`criteria`
`payload`	`text`	`channel.payload`
`status`	`text`	`status`
`tag`	`text`	`tag`
`type`	`text`	`channel.type`
`url`	`uri`	`channel.endpoint`