Da Vinci - Member Attribution (ATR) List
1.0.0 - STU 1 Publication
Da Vinci - Member Attribution (ATR) List
1.0.0 - STU 1 Publication
This page is part of the Risk Based Contracts Member Attribution List FHIR IG (v1.0.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
{
"resourceType" : "CapabilityStatement",
"id" : "atr-consumer",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>AtrConsumer</h2>\n <p>(Requirements Definition Capability Statement)</p>\n <p>Canonical URL: http://hl7.org/fhir/us/davinci-atr/CapabilityStatement/atr-consumer </p>\n <p>Published by: <b>HL7 International - Financial Management</b>\n </p>\n <p>This profile defines the expected capabilities of the <i>DaVinci ATR Consumer </i> actor. \n This actor is responsible for consuming the member attribution list for Risk Based Contracts. \n Typically Payers are the Producers of the member attribution list and Provider organization are consumers.</p>\n <h2>General</h2>\n <div class=\"table-wrapper\">\n <table>\n <tbody>\n <tr>\n <th>FHIR Version:</th>\n <td>4.0.1</td>\n </tr>\n <tr>\n <th>Supported formats:</th>\n <td>json</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h2>REST behavior</h2>\n <p>The primary focus of the Consumer is to retrieve and use the member attribution list for implementing different DaVinci use cases such as CDex, PDex. The list can also be used for other purposes as needed by the Consumer.</p>\n <p>\n <b>Security:</b>\n </p>\n <p>Implementations must meet the general security requirements documented in FHIR <a href=\"http://hl7.org/fhir/security.html\">Security guidance</a>.</p>\n <p>In addition the Consumer needs to meet the security requirements as outlined in the <a href=\"spec.html#smart-on-fhir-backend-services-authorization\">Formal Specification - Security Section.</a></p>\n <h3>Resource summary</h3>\n <div class=\"table-wrapper\">\n <table class=\"grid\">\n <thead>\n <tr>\n <th>Resource</th>\n <th>Search</th>\n <th>Read</th>\n <th>Read Version</th>\n <th>Instance History</th>\n <th>Resource History</th>\n <th>Create</th>\n <th>Update</th>\n <th>Delete</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>Coverage (<a href=\"StructureDefinition-atr-coverage.html\">Profile</a>)</th>\n <td/>\n <td>\n <a href=\"#Coverage-read\" title=\"Allows retrieval of a specific Coverage Resource\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>Group (<a href=\"StructureDefinition-atr-group.html\">Profile</a>)</th>\n <td>\n <a href=\"#Group-search-type\" title=\"Allows a user to search for existing Groups\">SHALL</a>\n </td>\n <td>\n <a href=\"#Group-read\" title=\"Allows retrieval of a specific Group\">SHALL</a>\n </td>\n <td>\n <a href=\"#Group-vread\" title=\"Allows retrieval of a specific version of a Group\">SHOULD</a>\n </td>\n <td>\n <a href=\"#Group-history-instance\" title=\"Allows review of changes to a Group over time\">SHOULD</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr> \n <tr>\n <th>Location (<a href=\"StructureDefinition-atr-location.html\">Profile</a>)</th>\n <td/>\n <td>\n <a href=\"#Location-read\" title=\"Allows retrieval of a specific Location Resource\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr> \n <tr>\n <th>Organization (<a href=\"StructureDefinition-atr-organization.html\">Profile</a>)</th>\n <td/>\n <td>\n <a href=\"#Organization-read\" title=\"Allows retrieval of a specific Organization Resource\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr> \n <tr>\n <th>Patient (<a href=\"StructureDefinition-atr-patient.html\">Profile</a>)</th>\n <td/>\n <td>\n <a href=\"#Patient-read\" title=\"Allows retrieval of a specific Patient Resource\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>Practitioner (<a href=\"StructureDefinition-atr-practitioner.html\">Profile</a>)</th>\n <td/>\n <td>\n <a href=\"#Practitioner-read\" title=\"Allows retrieval of a specific Practitioner Resource\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>PractitionerRole (<a href=\"StructureDefinition-atr-practitionerrole.html\">Profile</a>)</th>\n <td/>\n <td>\n <a href=\"#PractitionerRole-read\" title=\"Allows retrieval of a specific PractitionerRole Resource\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>RelatedPerson (<a href=\"StructureDefinition-atr-relatedperson.html\">Profile</a>)</th>\n <td/>\n <td>\n <a href=\"#RelatedPerson-read\" title=\"Allows retrieval of a specific RelatedPerson Resource\">SHALL</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n </tbody>\n </table>\n </div>\n \n <h3>FHIR Operations summary</h3>\n <p>The Consumer SHALL be capable of invoking the following FHIR operations.</p>\n \n <ul>\n <li>\n <a href=\"http://hl7.org/fhir/uv/bulkdata/OperationDefinition-group-export.html\">Group Export</a>\n </li>\n </ul>\n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/coverage.html\">Coverage</a>\n </h3>\n <p>Profile: <a href=\"StructureDefinition-atr-coverage.html\">http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-coverage</a>\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Coverage-read\"> </a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of a specific known Coverage Resource</p>\n </td>\n </tr>\n \n </tbody>\n </table>\n </div>\n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/group.html\">Group</a>\n </h3>\n <p>Profile: <a href=\"StructureDefinition-atr-group.html\">http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-group</a>\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Group-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>\n <p>Allows discovery of existing Groups corresponding to a Consumer using their own TAX and NPI Identifiers.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Group-read\"> </a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of a specific Group resource.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Group-vread\"> </a>\n <span>vread</span>\n </th>\n <td>\n <p>Allows retrieval of a historical version of a Group resource.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Group-history-instance\"> </a>\n <span>history-instance</span>\n </th>\n <td>\n <p>Allows review of changes to a Group over time</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n <h4>Search</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Type</th>\n <th>Definition & Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>identifier</th>\n <td>token</td>\n <td>Search using identifiers which can be Consumer NPI, Consumer TIN, Settlement Entity Identifier, Contract Identifier. Combinations of AND/OR logic for the different identifiers are allowed according to the FHIR specification.</td>\n </tr>\n <tr>\n <th>name</th>\n <td>string</td>\n <td>Search using Group name.</td>\n </tr>\n <tr>\n <th>period</th>\n <td>date</td>\n <td>Search using contract validity period.</td>\n </tr>\n </tbody>\n </table>\n </div>\n \n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/location.html\">Location</a>\n </h3>\n <p>Profile: <a href=\"StructureDefinition-atr-location.html\">http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-location</a>\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Location-read\"> </a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of a specific known Location Resource</p>\n </td>\n </tr>\n \n </tbody>\n </table>\n </div>\n \n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/organization.html\">Organization</a>\n </h3>\n <p>Profile: <a href=\"StructureDefinition-atr-organization.html\">http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-organization</a>\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Organization-read\"> </a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of a specific known Organization Resource</p>\n </td>\n </tr>\n \n </tbody>\n </table>\n </div>\n \n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a>\n </h3>\n <p>Profile: <a href=\"StructureDefinition-atr-patient.html\">http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-patient</a>\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Patient-read\"> </a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of a specific known Patient Resource</p>\n </td>\n </tr>\n \n </tbody>\n </table>\n </div>\n \n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/practitioner.html\">Practitioner</a>\n </h3>\n <p>Profile: <a href=\"StructureDefinition-atr-practitioner.html\">http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-practitioner</a>\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Practitioner-read\"> </a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of a specific known Practitioner Resource</p>\n </td>\n </tr>\n \n </tbody>\n </table>\n </div>\n \n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/practitionerrole.html\">PractitionerRole</a>\n </h3>\n <p>Profile: <a href=\"StructureDefinition-atr-practitionerrole.html\">http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-practitionerrole</a>\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"PractitionerRole-read\"> </a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of a specific known PractitionerRole Resource</p>\n </td>\n </tr>\n \n </tbody>\n </table>\n </div>\n \n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/relatedperson.html\">RelatedPerson</a>\n </h3>\n <p>Profile: <a href=\"StructureDefinition-atr-relatedperson.html\">http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-relatedperson</a>\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"RelatedPerson-read\"> </a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of a specific known RelatedPerson Resource</p>\n </td>\n </tr>\n \n </tbody>\n </table>\n </div>\n \n </div>"
},
"url" : "http://hl7.org/fhir/us/davinci-atr/CapabilityStatement/atr-consumer",
"version" : "1.0.0",
"name" : "DaVinciAtrConsumer",
"title" : "DaVinci ATR Consumer",
"status" : "draft",
"date" : "2014-07-06",
"publisher" : "HL7 International - Financial Management Work Group",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fm"
}
]
}
],
"description" : "This profile defines the expected capabilities of the ''Consumer'' role when conforming to the DaVinci Risk Based Contracts Member Attribution List Implementation Guide. This role is responsible for retrieving and using the Member Attribution List for DaVinci use cases such as CDex, PDex. The Member Attribution List can be used for other purposes also.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"json"
],
"rest" : [
{
"mode" : "client",
"documentation" : "The focus of the Consumer is to retrieve and use the Member Attribution List. Typically Payers are Producers and Provider Organizations/ACOs/HIEs etc act as Consumers. ",
"security" : {
"description" : "Implementations must meet the general security requirements documented in the security section of the implementation guide."
},
"resource" : [
{
"type" : "Coverage",
"supportedProfile" : [
"http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-coverage"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific Coverage Resource"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to a Coverage Instance over time"
}
]
},
{
"type" : "Group",
"supportedProfile" : [
"http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-group"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing Groups."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific Group Resource"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a Group Resource"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to a Group Resource over time"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Group-identifier",
"type" : "token"
}
]
},
{
"type" : "Location",
"supportedProfile" : [
"http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-location"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific Location Resource"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to a Location Instance over time"
}
]
},
{
"type" : "Organization",
"supportedProfile" : [
"http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-organization"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific Organization Resource"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to a Organization Instance over time"
}
]
},
{
"type" : "Patient",
"supportedProfile" : [
"http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-patient"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific Patient Resource"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to a Patient Instance over time"
}
]
},
{
"type" : "Practitioner",
"supportedProfile" : [
"http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-practitioner"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific Practitioner Resource"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to a Practitioner Instance over time"
}
]
},
{
"type" : "PractitionerRole",
"supportedProfile" : [
"http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-practitionerrole"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific PractitionerRole Resource"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to a PractitionerRole Instance over time"
}
]
},
{
"type" : "RelatedPerson",
"supportedProfile" : [
"http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-relatedperson"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific RelatedPerson Resource"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to a RelatedPerson Instance over time"
}
]
}
]
}
]
}
IG © 2019+ HL7 International - Financial Management Work Group. Package hl7.fhir.us.davinci-atr#1.0.0 based on FHIR 4.0.1. Generated 2021-02-08
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change