Subscription - FHIR Resource (dstu2)


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

Validate an Subscription FHIR Resource (dstu2)



Resource Attributes

AttributeField is listTypeDescription
channelfalseData Type# The channel on which to report matches to the criteria
contacttrueContactPoint# Contact details for source (e.g. troubleshooting)
criteriafalsestring# Rule for server push criteria
endfalseinstant# When to automatically delete the subscription
errorfalsestring# Latest error note
reasonfalsestring# Description of why this subscription was created
statusfalsecode# requested | active | error | off
tagtrueCoding# A tag to add to matching resources

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 the like so:

https://api.1up.health/fhir/dstu2/Subscription?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
contacttextcontact
criteriatextcriteria
payloadtextchannel.payload
statustextstatus
tagtexttag
typetextchannel.type
urlurichannel.endpoint