Argonaut User Facing Patient List
0.1.0 - CI Build

Argonaut User Facing Patient List - Local Development build (v0.1.0). See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

Client CapabilityStatement

This CapabilityStatement outlines the conformance requirements and expectations for Argonaut User Facing Patient List Client applications. It identifies the specific profiles and RESTful transactions for requesting user facing patient list data from an EHR using the Argonaut User Facing Patient List API. This includes the following interactions:

  1. Discovery of User Facing Patient Lists
  2. Fetching User Facing Patient Lists
  3. Fetching Additional Data about each Patient in a User Facing Patient Lists

This is a Requirements CapabilityStatement describing what capabilities are potentially relevant. It can be used as a template for creating an Instance CapabilityStatement by removing expectation extensions and making actual assertions associated with each capability to describe the capabilities of a deployed and configured implementation.

Server CapabilityStatement

This CapabilityStatement outlines the conformance requirements and expectations for Argonaut User Facing Patient List EHR Server. It identifies the specific profiles and RESTful transactions for requesting user facing patient list data from an EHR using the Argonaut User Facing Patient List API. This includes the following interactions:

  1. Discovery of User Facing Patient Lists
  2. Fetching User Facing Patient Lists
  3. Fetching Additional Data about each Patient in a User Facing Patient Lists

This is a Requirements CapabilityStatement describing what capabilities are potentially relevant. It can be used as a template for creating an Instance CapabilityStatement by removing expectation extensions and making actual assertions associated with each capability to describe the capabilities of a deployed and configured Server.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide

Group Get Page Operation

The Group resources can contain a lot of members and make dealing with them as a whole hard for a client. To work around this issue, the $getpage operation returns a List or Group with just a subset of its members. It is an instance level operation that uses the input parameters offset and count to specify the subset. $getPage?offset=X&count=Y The offset is 0 based and defaults to 0, and the count defaults to the _count of a search operation.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

GroupValueReference

This custom SearchParameter defines searching the Group resource by a Group.characteristic.valueReference element value. It is used in combination with the standardcharacteristic search parameter to query for Groups by characteristics that use valueReference values.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide

Argonaut Patient List (Group) Profile

This profile sets minimum expectations for the Group resource to record, search, and fetch user-facing patient lists.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide

Argonaut Patient List Member Appointment Extension

Some patient lists are defined by a specific appointment such as an list of patients being seen today. For these types of patient lists, an EHR MAY supply a reference to a specific Appointment that is the reason the target patient is a member of this patient list. This extension references the relevant Appointment resource for a Group.member so the client app can retrieve it.

Argonaut Patient List Member Encounter Extension

Some patient lists are defined by a specific encounter such as an admission list or a discharge list. For these types of patient lists, an EHR MAY supply a reference to a specific Encounter that is the reason the target patient is a member of this patient list. This extension references the relevant Encounter resource for a Group.member so the client app can retrieve it. The Encounter resource is based on the US Core Encounter profile.

Argonaut Patient List Questionnaire Extension

An EHR MAY defines additional data for the members in a Patient List using a FHIR Questionnaire based on the SDC Base Questionnaire profile. This extension references the Questionnaire resource so the client app can retrieve it. The Argonaut Patient List Member QuestionnaireResponse Extension provides a corresponding link to the completed answers to the Questionnaire for a Group.member. Note that typically the EHR and not the patient supplies the responses to the Questionnaire.

Argonaut Patient List Member QuestionnaireResponse Extension

An EHR MAY defines additional data for the members in a Patient List using a FHIR Questionnaire based on the SDC Base Questionnaire profile. This extension references the QuestionnaireResponse resource that represents the completed answers to the Questionnaire for a Group.member. The client app can use the reference to retrieve the data. Note that typically the EHR and not the patient supplies the responses to the Questionnaire. The Argonaut Patient List Questionnaire Extension provides a corresponding link to the Questionnaire

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide

Argonaut Group Characteristic Value Set

Initial set of group characteristic concepts for defining and searching for patient lists.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide

Argonaut Group Characteristic Code System

Initial set of group characteristic concepts for defining and searching for patient lists.