| Package | hl7.fhir.us.davinci-atr |
| Type | CapabilityStatement |
| Id | atr-consumer |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/davinci-atr/https://build.fhir.org/ig/HL7/davinci-atr/CapabilityStatement-atr-consumer.html |
| URL | http://hl7.org/fhir/us/davinci-atr/CapabilityStatement/atr-consumer |
| Version | 2.1.0 |
| Status | active |
| Date | 2014-07-06 |
| Name | DaVinciAtrConsumer |
| Title | DaVinci ATR Consumer |
| Realm | us |
| Authority | hl7 |
| 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. |
| Kind | requirements |
No resources found
| StructureDefinition | |
| atr-coverage | DaVinci ATR Coverage 3.1 |
| atr-group | Davinci ATR Group |
| atr-location | Davinci ATR Location |
| atr-organization | Davinci ATR Organization |
| atr-patient | Davinci ATR Patient |
| atr-practitioner | Davinci ATR Practitioner |
| atr-practitionerrole | Davinci ATR PractitionerRole |
| atr-relatedperson | Davinci ATR RelatedPerson 3.1 |
Note: links and images are rebased to the (stated) source
(Requirements Definition Capability Statement)
Canonical URL: http://hl7.org/fhir/us/davinci-atr/CapabilityStatement/atr-consumer
Published by: HL7 International - Financial Management
This profile defines the expected capabilities of the DaVinci ATR Consumer actor. This actor is responsible for consuming the member attribution list. Typically Payers are the Producers of the member attribution list and Provider organization are consumers.
| FHIR Version: | 4.0.1 |
|---|---|
| Supported formats: | json |
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.
Security:
Implementations must meet the general security requirements documented in the FHIR Security guidance.
In addition, the Consumer **SHOULD** meet the security requirements as outlined in the Formal Specification - Security Section.
In cases where the Consumers create resources in Producer systems such as Groups (Member Attribution Lists), the Consumers **SHOULD** provide the Provenance information using the X-Provenance Header as specified in Provenance Specification
| Resource | Search | Read | Read Version | Instance History | Resource History | Create | Update | Delete |
|---|---|---|---|---|---|---|---|---|
| Coverage (Profile) | SHALL | |||||||
| Group (Profile) | SHALL | SHALL | SHOULD | SHOULD | ||||
| Location (Profile) | SHALL | |||||||
| Organization (Profile) | SHALL | |||||||
| Patient (Profile) | SHALL | |||||||
| Practitioner (Profile) | SHALL | |||||||
| PractitionerRole (Profile) | SHALL | |||||||
| RelatedPerson (Profile) | SHALL |
The Consumer SHALL be capable of invoking the following FHIR operations.
Profile: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-coverage
Profile: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-group
| Parameter | Type | Definition & Chaining |
|---|---|---|
| identifier | token | Search using identifiers which can be the 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. |
| name | string | Search using Group name. |
| period | date | Search using contract validity period. |
Profile: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-location
Profile: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-organization
Profile: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-patient
Profile: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-practitioner
Profile: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-practitionerrole
Profile: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-relatedperson
FHIR{
"resourceType": "CapabilityStatement",
"id": "atr-consumer",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fm"
}
],
"url": "http://hl7.org/fhir/us/davinci-atr/CapabilityStatement/atr-consumer",
"version": "2.1.0",
"name": "DaVinciAtrConsumer",
"title": "DaVinci ATR Consumer",
"status": "active",
"date": "2014-07-06",
"publisher": "HL7 International / Financial Management",
"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"
}
]
}
]
}
]
}