Subscription - FHIR Resource (r4)

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

Validate an Subscription FHIR Resource (r4)

Subscription Attributes

AttributeField is listTypeDescription

Description: requested | active | error | off

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "requested"

Learn more about the (Subscription) status FHIR attribute

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

FHIR Version: r4

Attribute Type : ContactPoint

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"contact": [
  {
    "system": "phone",
    "value": "ext 4123"
  }
]

Learn more about the (Subscription) contact FHIR attribute

Description: When to automatically delete the subscription

FHIR Version: r4

Attribute Type : instant

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"end": "2021-01-01T00:00:00Z"

Learn more about the (Subscription) end FHIR attribute

Description: Description of why this subscription was created

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"reason": "Monitor new neonatal function"

Learn more about the (Subscription) reason FHIR attribute

Description: Rule for server push

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"criteria": "Observation?code=http://loinc.org|1975-2"

Learn more about the (Subscription) criteria FHIR attribute

Description: Latest error note

FHIR Version: r4

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: The channel on which to report matches to the criteria

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"channel": {
  "type": "rest-hook",
  "endpoint": "https://biliwatch.com/customers/mount-auburn-miu/on-result",
  "payload": "application/fhir+json",
  "header": [
    "Authorization: Bearer secret-token-abc-123"
  ]
}

Learn more about the (Subscription) channel FHIR attribute

Subscription Example

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

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
  "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" : "<url>", // Where the channel points to
    "payload" : "<code>", // MIME type to send, or omit for no payload
    "header" : ["<string>"] // Usage depends on the channel type
  }
}

Subscription Search Parameters

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

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

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