Subscription - FHIR Resource (stu3)


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

Validate an Subscription FHIR Resource (stu3)



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 Example

{
  "status": "requested",
  "end": "2021-01-01T00:00:00Z",
  "resourceType": "Subscription",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">[Put rendering here]</div>"
  },
  "tag": [
    {
      "code": "bili-done",
      "system": "http://example.org/fhir/cs/internal"
    }
  ],
  "reason": "Monitor new neonatal function",
  "contact": [
    {
      "system": "phone",
      "value": "ext 4123"
    }
  ],
  "criteria": "Observation?code=http://loinc.org|1975-2",
  "id": "example",
  "channel": {
    "header": [
      "Authorization: Bearer secret-token-abc-123"
    ],
    "endpoint": "https://biliwatch.com/customers/mount-auburn-miu/on-result",
    "type": "rest-hook",
    "payload": "application/fhir+json"
  }
}

Subscription Structure


  
{
  "resourceType" : "Subscription",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "status" : "<code>", // R!  requested | active | error | off
  "contact" : [{ ContactPoint }], // Contact details for source (e.g. troubleshooting)
  "end" : "<instant>", // When to automatically delete the subscription
  "reason" : "<string>", // R!  Description of why this subscription was created
  "criteria" : "<string>", // R!  Rule for server push criteria
  "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>", // Mimetype to send, or omit for no payload
    "header" : ["<string>"] // Usage depends on the channel type
  },
  "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/stu3/Subscription?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
add-tagtexttag
contacttextcontact
criteriatextcriteria
payloadtextchannel.payload
statustextstatus
typetextchannel.type
urlurichannel.endpoint