Reading Topics

The Spine published a list of Topics to which Client Systems may subscribe. Topics describe the event and list the filters clients may use when subscribing. Initially, the Spine will support a single topic: pregnancy-event and Spine Client Systems may choose not to query this endpoint and simply use this well-known Topic ID when subscribing.

Read all Topics

GET /SubscriptionTopic

Responses:

Code

Description

200

JSON

{
    "resourceType": "Bundle",
    "type": "searchset",
    "total": 1,
    "entry": [
        {
            "resource": {
                "resourceType": "SubscriptionTopic",
                "id": "pregnancy-event",
                "url": "https://clevermed.com/fhir/r5/SubscriptionTopic/pregnancy-event",
                "title": "Pregnancy Event",
                "status": "active",
                "description": "A topic to which Spine Client Systems can subscribe to be notified about pregnancy record events",
                "resourceTrigger": [
                    {
                        "description": "This topic is triggered each time a FHIR pregnancy record within the Spine is created or updated",
                        "resource": "http://hl7.org/fhir/StructureDefinition/Patient",
                        "supportedInteraction": [
                            "create",
                            "update"
                        ]
                    }
                ],
                "canFilterBy": [
                    {
                        "description": "Match events based on the Logical ID of the pregnancy",
                        "resource": "Patient",
                        "filterParameter": "patient-id",
                        "modifier": [
                            "exact"
                        ]
                    },
                    {
                        "description": "Match events for pregnancies which have previously been associated with a specific care location",
                        "resource": "Patient",
                        "filterParameter": "care-location-id",
                        "modifier": [
                            "exact"
                        ]
                    }
                ]
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}