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
{
"resourceType" : "CapabilityStatement",
"id" : "server",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"> <h2 id=\"title\">Server CapabilityStatement</h2> <ul> <li>Implementation Guide Version: 0.1.0</li> <li>FHIR Version: 4.0.1</li> <li>Supported formats: JSON</li> <li>Published: 2021-01-28</li> <li>Published by: Argonaut Project</li> </ul> <p>This CapabilityStatement outlines the conformance requirements and expectations for Argonaut User Facing Patient List <strong>EHR Server</strong>. 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:</p> <ol> <li>Discovery of User Facing Patient Lists</li> <li>Fetching User Facing Patient Lists</li> <li>Fetching Additional Data about each Patient in a User Facing Patient Lists</li> </ol> <p>This is a <a href=\"http://hl7.org/fhir/capabilitystatement.html#requirements\">Requirements CapabilityStatement</a> describing what capabilities are potentially relevant. It can be used as a template for creating an <a href=\"http://hl7.org/fhir/capabilitystatement.html#instance\">Instance CapabilityStatement</a> by removing expectation extensions and making actual assertions associated with each capability to describe the capabilities of a deployed and configured Server.</p> <h3 id=\"igs\" class=\"no_toc\">SHOULD Support the Following Implementation Guides:</h3> <ul> <li><a href=\"http://hl7.org/fhir/us/core/index.html\">HL7 FHIR® US Core Implementation Guide STU3 Release 3.1.1</a></li> </ul> <h3 id=\"behavior\">FHIR RESTful Capabilities</h3> <p>The Server <strong>SHALL</strong>:</p> <ol> <li>Support discovery of user facing patient lists</li> <li>Support fetching user facing lists</li> <li>Support JSON source formats for all transactions</li> <li>Declare a CapabilityStatement identifying the transactions and profiles supported</li> </ol> <p>The Server <strong>SHOULD</strong>:</p> <ol> <li>Support fetching additional data about each patient in a user facing patient lists</li> <li>Support XML source formats for all transactions</li> </ol> <p id=\"security\"><strong>Security:</strong></p> <ol> <li>See the <a href=\"http://hl7.org/fhir/us/core/security.html\">US Core General Security Considerations</a> section for requirements and recommendations.</li> </ol> <p><strong>Summary of System Wide Interactions</strong></p> <ul> <li><strong>SHOULD</strong> support the <code>transaction</code> interaction.</li> <li><strong>SHOULD</strong> support the <code>batch</code> interaction.</li> <li><strong>MAY</strong> support the <code>search-system</code> interaction.</li> <li><strong>MAY</strong> support the <code>history-system</code> interaction.</li> </ul> <h3 id=\"resource--details\" class=\"no_toc\">RESTful Capabilities by Resource/Profile:</h3> <p><strong>Summary of Search Criteria</strong></p> <table class=\"grid\"> <thead> <tr> <th>Resource Type</th> <th>Supported Profiles</th> <th>Supported Searches</th> <th>Supported <code>_includes</code></th> <th>Supported <code>_revincludes</code></th> <th>Supported Operations</th> </tr> </thead> <tbody> <tr> <td> <a href=\"#appointment\">Appointment</a> </td> <td> </td> <td> _id </td> <td> </td> <td> </td> <td> </td> </tr> <tr> <td> <a href=\"#encounter\">Encounter</a> </td> <td> <a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter\">US Core Encounter Profile</a> </td> <td> _id </td> <td> </td> <td> </td> <td> </td> </tr> <tr> <td> <a href=\"#group\">Group</a> </td> <td> <a href=\"StructureDefinition-patientlist.html\">Argonaut User Facing Patient List (Group) Profile</a> </td> <td> type, _summary, managing-entity, characteristic, value-reference, _include, _id characteristic+value-reference </td> <td> Group:member </td> <td> </td> <td> </td> </tr> <tr> <td> <a href=\"#questionnaire\">Questionnaire</a> </td> <td> <a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire\">SDC Base Questionnaire</a> </td> <td> _id </td> <td> </td> <td> </td> <td> </td> </tr> <tr> <td> <a href=\"#questionnaireresponse\">QuestionnaireResponse</a> </td> <td> <a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse\">SDC Questionnaire Response</a> </td> <td> _id </td> <td> </td> <td> </td> <td> </td> </tr> </tbody> </table> <h4 id=\"appointment\" class=\"no_toc\">Appointment</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>For getting additional data about Group members, the Argonaut Patient List (Group) Profile support an extension on the <code>Group.member</code> element for directly accessing one or more Appointment resources for each patient on the patient list. The Server <strong>MAY</strong> supply this extension so that the Client can efficiently fetch the Appointment resource.</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>vread</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHOULD</strong> be capable of returning a Appointment resource using: <code class=\"highlighter-rouge\">GET [base]/Appointment/[id]</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"http://hl7.org/fhir/R4/search.html\"> _id</a> </td> <td> token </td> <td align=\"left\"> <p>for fetching of additional appointment data about group members. The Server <strong>SHOULD</strong> support comma-separated values.</p> </td> </tr> </tbody> </table> <hr/> <h4 id=\"encounter\" class=\"no_toc\">Encounter</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Supported Profiles: <a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter\">US Core Encounter Profile</a> </p> <p>Resource Specific Documentation:</p> <blockquote><p>For getting additional data about Group members, the Argonaut Patient List (Group) Profile supports an extension on the <code>Group.member</code> element for directly accessing one or more Encounter resources for each patient on the patient list. The Server <strong>MAY</strong> supply this extension so that the Client can efficiently fetch the Encounter resource.</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>vread</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHOULD</strong> be capable of returning a Encounter resource using: <code class=\"highlighter-rouge\">GET [base]/Encounter/[id]</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"http://hl7.org/fhir/R4/search.html\"> _id</a> </td> <td> token </td> <td align=\"left\"> <p>for fetching of additional encounter data about group members. The Server <strong>SHOULD</strong> support comma-separated values.</p> </td> </tr> </tbody> </table> <hr/> <h4 id=\"group\" class=\"no_toc\">Group</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href=\"StructureDefinition-patientlist.html\">Argonaut User Facing Patient List (Group) Profile</a> </p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type for discovery and fetching of user facing lists. For getting additional data about Group members. The Server <strong>MAY</strong> supply one or more of these extensions:</p> <ol> <li><a href=\"https://argonautproject.github.io/patient-lists/StructureDefinition-patientlist-appointment.html#profile\">Argonaut Patient List Member Appointment Extension</a></li> <li><a href=\"https://argonautproject.github.io/patient-lists/StructureDefinition-patientlist-encounter.html#profile\">Argonaut Patient List Member Encounter Extension</a></li> <li><a href=\"https://argonautproject.github.io/patient-lists/StructureDefinition-patientlist-questionnaire.html#profile\">Argonaut User Facing Patient List Questionnaire Extension</a></li> <li><a href=\"https://argonautproject.github.io/patient-lists/StructureDefinition-patientlist-questionnaireresponse.html#profile\">Argonaut User Facing Patient List Member QuestionnaireResponse Extension</a></li> </ol> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>read</code><sup>†</sup>.</li><li><strong>SHOULD</strong> support <code>search-type</code><sup>†</sup>, <code>vread</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <blockquote>search-type<sup>†</sup><ol> <li>Servers <strong>SHALL</strong> require the following search parameters and parameter values for discovery of user-facing lists: <ul> <li>_summary=“true"</li> <li>type=“person”.</li> </ul> </li> <li>Servers <strong>SHALL</strong> include <code>Group.characteristic</code> <em>in addition to</em> all the standard Group summary elements.</li> <li>Servers <strong>SHALL</strong> support discovering all available patient lists using the required parameter</li> <li>Servers <strong>SHOULD</strong> support discovering all available patient lists managed by a particular organization or practitioner using the required parameters and the <code>managing-entity</code> search parameter.</li> <li>Servers <strong>SHOULD</strong> support discovering all available patient lists that have a particular characteristic using the required parameters and the combination of <code>characteristic</code> and <code>value-reference</code> search parameters</li> </ol> </blockquote><blockquote>read<sup>†</sup><p>When the Patient list is too large be able to return a whole resource:</p> <ul> <li>The Server <strong>SHOULD NOT</strong> return first-page results as described <a href=\"http://hl7.org/fhir/search.html#count\">here</a></li> <li>The Server <strong>SHOULD</strong> return an <em>OperationOutcome</em> indicating that the client needs to call the <code>$getpage</code>operation to return a Group</li> </ul> </blockquote> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a Group resource using: <code class=\"highlighter-rouge\">GET [base]/Group/[id]</code> </li> <li> A Server <strong>SHOULD</strong> be capable of supporting the following _includes: Group:member - <code class=\"highlighter-rouge\">GET [base]/Group?[parameter=value]&_include=Group:member</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"http://hl7.org/fhir/R4/group.html#search\"> type</a> </td> <td> token </td> <td align=\"left\"> <p>required search parameters and parameter value <code> type=person</code> for discovery of user-facing lists:</p> </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"http://hl7.org/fhir/R4/search.html\"> _summary</a> </td> <td> token </td> <td align=\"left\"> <p>required search parameters and parameter value <code> _summary=true</code> for discovery of user-facing lists:</p> </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"http://hl7.org/fhir/R4/group.html#search\"> managing-entity</a> </td> <td> reference </td> <td align=\"left\"> <p>for discovery of user-facing lists managed by a particular organization or practitioner</p> </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"http://hl7.org/fhir/R4/group.html#search\"> characteristic</a> </td> <td> token </td> <td align=\"left\"> <p>for discovery of user-facing lists by a characteristic used in combination with <code>value-reference</code></p> </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-argonaut-group-value-reference.html\"> value-reference</a> </td> <td> reference </td> <td align=\"left\"> <p>for discovery of user-facing lists by a characteristic used in combination with <code>characteristic</code></p> </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"http://hl7.org/fhir/R4/search.html\"> _include</a> </td> <td> token </td> <td align=\"left\"> <p>the <code>_include</code> parameter can be used when fetching a Group resource to include all the Patient resources in addition to Group</p> </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"http://hl7.org/fhir/R4/search.html\"> _id</a> </td> <td> token </td> <td align=\"left\"> <p>for fetching of user facing lists</p> </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td>characteristic+value-reference </td> <td>token+reference </td> </tr> </tbody> </table> <hr/> <h4 id=\"questionnaire\" class=\"no_toc\">Questionnaire</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Supported Profiles: <a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire\">SDC Base Questionnaire</a> </p> <p>Resource Specific Documentation:</p> <blockquote><p>For getting additional data about Group members, the Argonaut Patient List (Group) Profile supports 2 extension for directly accessing the Group level Questionnaire and the resultant pre-filled QuestionnaireResponse form for each patient on the patient list: The Server <strong>MAY</strong> supply this extension so that the Client can fetch the form definitions in the Questionnaire resource and the form data in the QuestionnaireResponse resource.</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>vread</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHOULD</strong> be capable of returning a Questionnaire resource using: <code class=\"highlighter-rouge\">GET [base]/Questionnaire/[id]</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"http://hl7.org/fhir/R4/search.html\"> _id</a> </td> <td> token </td> <td align=\"left\"> <p>for fetching the definitions of associated data about group members represented in the Questionnaire resource. The Server <strong>SHOULD</strong> support comma-separated values.</p> </td> </tr> </tbody> </table> <hr/> <h4 id=\"questionnaireresponse\" class=\"no_toc\">QuestionnaireResponse</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Supported Profiles: <a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse\">SDC Questionnaire Response</a> </p> <p>Resource Specific Documentation:</p> <blockquote><p>For getting additional data about Group members, the Argonaut Patient List (Group) Profile supports 2 extension for directly accessing the Group level Questionnaire and the resultant pre-filled QuestionnaireResponse form for each patient on the patient list: The Server <strong>MAY</strong> supply these extensions so that the Client can fetch the form definitions in the Questionnaire resource and the form data in the QuestionnaireResponse resource.</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>vread</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHOULD</strong> be capable of returning a QuestionnaireResponse resource using: <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"http://hl7.org/fhir/R4/search.html\"> _id</a> </td> <td> token </td> <td align=\"left\"> <p>for fetching associated data about group members represented in the QuestionnaireResponse resource. The Server <strong>SHOULD</strong> support comma-separated values.</p> </td> </tr> </tbody> </table> <hr/> </div>"
},
"url" : "http://www.fhir.org/guides/argonaut/patient-list/CapabilityStatement/server",
"version" : "0.1.0",
"name" : "ServerCapabilityStatement",
"title" : "Server CapabilityStatement",
"status" : "active",
"experimental" : false,
"date" : "2021-01-28",
"publisher" : "Argonaut Project",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "https://confluence.hl7.org/display/AP/Argonaut+Project+Home"
}
]
}
],
"description" : "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:\n\n1. Discovery of User Facing Patient Lists\n2. Fetching User Facing Patient Lists\n3. Fetching Additional Data about each Patient in a User Facing Patient Lists\n\nThis is a [Requirements CapabilityStatement](http://hl7.org/fhir/capabilitystatement.html#requirements) describing what capabilities are potentially relevant. It can be used as a template for creating an [Instance CapabilityStatement](http://hl7.org/fhir/capabilitystatement.html#instance) by removing expectation extensions and making actual assertions associated with each capability to describe the capabilities of a deployed and configured Server.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"json"
],
"patchFormat" : [
"application/json-patch+json"
],
"implementationGuide" : [
"http://www.fhir.org/guides/argonaut/patient-list/ImplementationGuide/ig",
"http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|3.1.1"
],
"rest" : [
{
"mode" : "server",
"documentation" : "The Server **SHALL**:\n\n1. Support discovery of user facing patient lists\n1. Support fetching user facing lists\n1. Support JSON source formats for all transactions\n1. Declare a CapabilityStatement identifying the transactions and profiles supported\n\nThe Server **SHOULD**:\n\n1. Support fetching additional data about each patient in a user facing patient lists\n1. Support XML source formats for all transactions",
"security" : {
"description" : "1. See the [US Core General Security Considerations](http://hl7.org/fhir/us/core/security.html) section for requirements and recommendations."
},
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Appointment",
"documentation" : "For getting additional data about Group members, the Argonaut Patient List (Group) Profile support an extension on the `Group.member` element for directly accessing one or more Appointment resources for each patient on the patient list. The Server **MAY** supply this extension so that the Client can efficiently fetch the Appointment resource.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : " for fetching of additional appointment data about group members. The Server **SHOULD** support comma-separated values."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Encounter",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
],
"documentation" : "For getting additional data about Group members, the Argonaut Patient List (Group) Profile supports an extension on the `Group.member` element for directly accessing one or more Encounter resources for each patient on the patient list. The Server **MAY** supply this extension so that the Client can efficiently fetch the Encounter resource.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : " for fetching of additional encounter data about group members. The Server **SHOULD** support comma-separated values."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "characteristic"
},
{
"url" : "required",
"valueString" : "value-reference"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Group",
"supportedProfile" : [
"http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist"
],
"documentation" : "Required resource type for discovery and fetching of user facing lists. For getting additional data about Group members. The Server **MAY** supply one or more of these extensions:\n\n1. [Argonaut Patient List Member Appointment Extension](https://argonautproject.github.io/patient-lists/StructureDefinition-patientlist-appointment.html#profile)\n1. [Argonaut Patient List Member Encounter Extension](https://argonautproject.github.io/patient-lists/StructureDefinition-patientlist-encounter.html#profile)\n1. [Argonaut User Facing Patient List Questionnaire Extension](https://argonautproject.github.io/patient-lists/StructureDefinition-patientlist-questionnaire.html#profile)\n1. [Argonaut User Facing Patient List Member QuestionnaireResponse Extension](https://argonautproject.github.io/patient-lists/StructureDefinition-patientlist-questionnaireresponse.html#profile)",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "1. Servers **SHALL** require the following search parameters and parameter values for discovery of user-facing lists:\n - _summary=“true\"\n - type=“person”.\n1. Servers **SHALL** include `Group.characteristic` *in addition to* all the standard Group summary elements.\n1. Servers **SHALL** support discovering all available patient lists using the required parameter\n1. Servers **SHOULD** support discovering all available patient lists managed by a particular organization or practitioner using the required parameters and the `managing-entity` search parameter.\n1. Servers **SHOULD** support discovering all available patient lists that have a particular characteristic using the required parameters and the combination of `characteristic` and `value-reference` search parameters "
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "When the Patient list is too large be able to return a whole resource:\n- The Server **SHOULD NOT** return first-page results as described [here](http://hl7.org/fhir/search.html#count)\n- The Server **SHOULD** return an *OperationOutcome* indicating that the client needs to call the `$getpage`operation to return a Group"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchInclude" : [
"Group:member"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/Group-type",
"type" : "token",
"documentation" : "required search parameters and parameter value ` type=person` for discovery of user-facing lists:"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_summary",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-summary",
"type" : "token",
"documentation" : "required search parameters and parameter value ` _summary=true` for discovery of user-facing lists:"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "managing-entity",
"definition" : "http://hl7.org/fhir/SearchParameter/Group-managing-entity",
"type" : "reference",
"documentation" : "for discovery of user-facing lists managed by a particular organization or practitioner"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "characteristic",
"definition" : "http://hl7.org/fhir/SearchParameter/Group-characteristic",
"type" : "token",
"documentation" : "for discovery of user-facing lists by a characteristic used in combination with `value-reference`"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "value-reference",
"definition" : "http://www.fhir.org/guides/argonaut/patient-list/SearchParameter/argonaut-group-value-reference",
"type" : "reference",
"documentation" : "for discovery of user-facing lists by a characteristic used in combination with `characteristic`"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_include",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-include",
"type" : "token",
"documentation" : "the `_include` parameter can be used when fetching a Group resource to include all the Patient resources in addition to Group"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : " for fetching of user facing lists"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Questionnaire",
"supportedProfile" : [
"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire"
],
"documentation" : "For getting additional data about Group members, the Argonaut Patient List (Group) Profile supports 2 extension for directly accessing the Group level Questionnaire and the resultant pre-filled QuestionnaireResponse form for each patient on the patient list: The Server **MAY** supply this extension so that the Client can fetch the form definitions in the Questionnaire resource and the form data in the QuestionnaireResponse resource.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "for fetching the definitions of associated data about group members represented in the Questionnaire resource. The Server **SHOULD** support comma-separated values."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "QuestionnaireResponse",
"supportedProfile" : [
"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse"
],
"documentation" : "For getting additional data about Group members, the Argonaut Patient List (Group) Profile supports 2 extension for directly accessing the Group level Questionnaire and the resultant pre-filled QuestionnaireResponse form for each patient on the patient list: The Server **MAY** supply these extensions so that the Client can fetch the form definitions in the Questionnaire resource and the form data in the QuestionnaireResponse resource.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : " for fetching associated data about group members represented in the QuestionnaireResponse resource. The Server **SHOULD** support comma-separated values."
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "transaction",
"documentation" : "The Server **SHOULD** support transaction interactions to Getting Additional Data About Group Members"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "batch",
"documentation" : "The Server **SHOULD** support batch interactions to Getting Additional Data About Group Members"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-system"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-system"
}
]
}
]
}