Package | ihe.iti.fais |
Type | CapabilityStatement |
Id | IHE.FAIS.BeneficiaryRequestor |
FHIR Version | R4 |
Source | https://profiles.ihe.net/ITI/FAIS/https://build.fhir.org/ig/IHE/ITI.Finance/CapabilityStatement-IHE.FAIS.BeneficiaryRequestor.html |
URL | https://profiles.ihe.net/ITI/FAIS/CapabilityStatement/IHE.FAIS.BeneficiaryRequestor |
Version | 1.0.1-current |
Status | active |
Date | 2024-07-17 |
Name | IHE_FAIS_BeneficiaryRequestor |
Title | IHE FAIS Beneficiary Requestor |
Realm | uv |
Authority | ihe |
Description | CapabilityStatement for [Beneficiary Requestor Actor](volume-1.html#beneficiary-requestor). The Beneficiary Requestor can enroll beneficiaries and optionally query insurance plans from a Beneficiary Manager. |
Kind | requirements |
No resources found
OperationDefinition | |
IHE.FAIS.EnrollmentRequest.Submit | FAIS Enrollment Request $submit |
SearchParameter | |
InsurancePlan-benefitType | InsurancePlan_benefitType |
InsurancePlan-coverageArea | InsurancePlan_coverageArea |
InsurancePlan-network | InsurancePlan_network |
StructureDefinition | |
IHE.FAIS.EnrollmentRequest | FAIS EnrollmentRequest Profile |
IHE.FAIS.EnrollmentResponse | FAIS EnrollmentResponse Profile |
IHE.FAIS.InsurancePlan | FAIS InsurancePlan Profile |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement IHE.FAIS.BeneficiaryRequestor
application/fhir+xml
, application/fhir+json
Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
client
FAIS Beneficiary Requestor provides capability to query insurance plans, submit enrollment requests, and query for enrollment responses.
Recommend ATNA, encouraged IHE-IUA or SMART-app-launch
search-system
interaction.The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|
InsurancePlan | Supported Profiles FAIS InsurancePlan Profile | y | y | _lastUpdated, _id, status, type, name, identifier, administered-by, owned-by, network, coverage-area, benefit-type | |||||
EnrollmentRequest | Supported Profiles FAIS EnrollmentRequest Profile | $submit | |||||||
EnrollmentResponse | Supported Profiles FAIS EnrollmentResponse Profile | y | y | _lastUpdated, _id, status, request |
FAIS Query Insurance Plan transaction [ITI-121]
Conformance | Parameter | Type | Documentation |
---|---|---|---|
MAY | _lastUpdated | date | When the resource version last changed. The values for this shall support these prefixes: gt, lt, ge, le, sa, and eb. |
MAY | _id | token | Logical id of this artifact |
MAY | status | token | The status of the Insurance Plan |
MAY | type | token | The type of the Insurance Plan |
MAY | name | string | The name of the Insurance Plan |
MAY | identifier | token | The business identifiers of the Insurance Plan |
MAY | administered-by | reference | Who administers the Insurance Plan |
MAY | owned-by | reference | Who owns the Insurance Plan |
MAY | network | reference | The Insurance Plan network |
MAY | coverage-area | reference | The Insurance Plan coverage area |
MAY | benefit-type | token | The Insurance Plan type of benefit |
FAIS Enroll Beneficiary transaction [ITI-122]
read
, search-type
.FAIS Check Enrollment Status transaction [ITI-123]
Conformance | Parameter | Type | Documentation |
---|---|---|---|
MAY | _lastUpdated | date | When the resource version last changed. The values for this shall support these prefixes: gt, lt, ge, le, sa, and eb. |
MAY | _id | token | Logical id of this artifact |
MAY | status | token | The status of the response |
MAY | request | reference | The enrollment request |
{ "resourceType": "CapabilityStatement", "id": "IHE.FAIS.BeneficiaryRequestor", "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "url": "https://profiles.ihe.net/ITI/FAIS/CapabilityStatement/IHE.FAIS.BeneficiaryRequestor", "version": "1.0.1-current", "name": "IHE_FAIS_BeneficiaryRequestor", "title": "IHE FAIS Beneficiary Requestor", "status": "active", "experimental": false, "date": "2024-07-17", "publisher": "IHE IT Infrastructure Technical Committee", "contact": [ { "telecom": [ { "system": "url", "value": "https://www.ihe.net/ihe_domains/it_infrastructure/" } ] }, { "telecom": [ { "system": "email", "value": "iti@ihe.net" } ] }, { "name": "IHE IT Infrastructure Technical Committee", "telecom": [ { "system": "email", "value": "iti@ihe.net" } ] } ], "description": "CapabilityStatement for [Beneficiary Requestor Actor](volume-1.html#beneficiary-requestor).\n\nThe Beneficiary Requestor can enroll beneficiaries and optionally query insurance plans from a Beneficiary Manager.", "jurisdiction": [ { "coding": [ { "system": "http://unstats.un.org/unsd/methods/m49/m49.htm", "code": "001" } ] } ], "kind": "requirements", "fhirVersion": "4.0.1", "format": [ "application/fhir+xml", "application/fhir+json" ], "rest": [ { "mode": "client", "documentation": "FAIS Beneficiary Requestor provides capability to query insurance plans, submit enrollment requests, and query for enrollment responses.", "security": { "description": "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)" }, "resource": [ { "type": "InsurancePlan", "supportedProfile": [ "https://profiles.ihe.net/ITI/FAIS/StructureDefinition/IHE.FAIS.InsurancePlan" ], "documentation": "FAIS Query Insurance Plan transaction [[ITI-121]](ITI-121.html)", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "read" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "search-type" } ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "_lastUpdated", "type": "date", "documentation": "When the resource version last changed. The values for this shall support these prefixes: gt, lt, ge, le, sa, and eb." }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "_id", "type": "token", "documentation": "Logical id of this artifact" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "status", "type": "token", "documentation": "The status of the Insurance Plan" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "type", "type": "token", "documentation": "The type of the Insurance Plan" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "name", "type": "string", "documentation": "The name of the Insurance Plan" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "identifier", "type": "token", "documentation": "The business identifiers of the Insurance Plan" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "administered-by", "type": "reference", "documentation": "Who administers the Insurance Plan" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "owned-by", "type": "reference", "documentation": "Who owns the Insurance Plan" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "network", "definition": "https://profiles.ihe.net/ITI/FAIS/SearchParameter/InsurancePlan-network", "type": "reference", "documentation": "The Insurance Plan network" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "coverage-area", "definition": "https://profiles.ihe.net/ITI/FAIS/SearchParameter/InsurancePlan-coverageArea", "type": "reference", "documentation": "The Insurance Plan coverage area" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "benefit-type", "definition": "https://profiles.ihe.net/ITI/FAIS/SearchParameter/InsurancePlan-benefitType", "type": "token", "documentation": "The Insurance Plan type of benefit" } ] }, { "type": "EnrollmentRequest", "supportedProfile": [ "https://profiles.ihe.net/ITI/FAIS/StructureDefinition/IHE.FAIS.EnrollmentRequest" ], "documentation": "FAIS Enroll Beneficiary transaction [[ITI-122]](ITI-122.html)", "operation": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "submit", "definition": "https://profiles.ihe.net/ITI/FAIS/OperationDefinition/IHE.FAIS.EnrollmentRequest.Submit", "documentation": "Submits an enrollment request to enroll a new beneficiary with the request coverage. FAIS Enroll Beneficiary transaction [[ITI-122]](ITI-122.html)" } ] }, { "type": "EnrollmentResponse", "supportedProfile": [ "https://profiles.ihe.net/ITI/FAIS/StructureDefinition/IHE.FAIS.EnrollmentResponse" ], "documentation": "FAIS Check Enrollment Status transaction [[ITI-123]](ITI-123.html)", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "read" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "search-type" } ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "_lastUpdated", "type": "date", "documentation": "When the resource version last changed. The values for this shall support these prefixes: gt, lt, ge, le, sa, and eb." }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "_id", "type": "token", "documentation": "Logical id of this artifact" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "status", "type": "token", "documentation": "The status of the response" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "request", "type": "reference", "documentation": "The enrollment request" } ] } ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "search-system" } ] } ] }