FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/IHE.FAIS.BeneficiaryRequestor

Packageihe.iti.fais
TypeCapabilityStatement
IdIHE.FAIS.BeneficiaryRequestor
FHIR VersionR4
Sourcehttps://profiles.ihe.net/ITI/FAIS/https://build.fhir.org/ig/IHE/ITI.Finance/CapabilityStatement-IHE.FAIS.BeneficiaryRequestor.html
URLhttps://profiles.ihe.net/ITI/FAIS/CapabilityStatement/IHE.FAIS.BeneficiaryRequestor
Version1.0.1-current
Statusactive
Date2024-07-17
NameIHE_FAIS_BeneficiaryRequestor
TitleIHE FAIS Beneficiary Requestor
Realmuv
Authorityihe
DescriptionCapabilityStatement for [Beneficiary Requestor Actor](volume-1.html#beneficiary-requestor). The Beneficiary Requestor can enroll beneficiaries and optionally query insurance plans from a Beneficiary Manager.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

OperationDefinition
IHE.FAIS.EnrollmentRequest.SubmitFAIS Enrollment Request $submit
SearchParameter
InsurancePlan-benefitTypeInsurancePlan_benefitType
InsurancePlan-coverageAreaInsurancePlan_coverageArea
InsurancePlan-networkInsurancePlan_network
StructureDefinition
IHE.FAIS.EnrollmentRequestFAIS EnrollmentRequest Profile
IHE.FAIS.EnrollmentResponseFAIS EnrollmentResponse Profile
IHE.FAIS.InsurancePlanFAIS InsurancePlan Profile

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement IHE.FAIS.BeneficiaryRequestor

IHE FAIS Beneficiary Requestor

  • Implementation Guide Version: 1.0.1-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2024-07-17
  • Published by: IHE IT Infrastructure Technical Committee

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.

FHIR RESTful Capabilities

Mode: client

FAIS Beneficiary Requestor provides capability to query insurance plans, submit enrollment requests, and query for enrollment responses.

Security

Recommend ATNA, encouraged IHE-IUA or SMART-app-launch

Summary of System-wide Interactions
  • MAY support the search-systeminteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
InsurancePlanSupported Profiles
  FAIS InsurancePlan Profile
yy_lastUpdated, _id, status, type, name, identifier, administered-by, owned-by, network, coverage-area, benefit-type
EnrollmentRequestSupported Profiles
  FAIS EnrollmentRequest Profile
$submit
EnrollmentResponseSupported Profiles
  FAIS EnrollmentResponse Profile
yy_lastUpdated, _id, status, request

Resource Conformance: MAY InsurancePlan

Core FHIR Resource
InsurancePlan
Reference Policy
Interaction summary
  • MAY support read, search-type.

Supported Profiles

FAIS InsurancePlan Profile

Documentation

FAIS Query Insurance Plan transaction [ITI-121]

Search Parameters
ConformanceParameterTypeDocumentation
MAY_lastUpdateddate

When the resource version last changed. The values for this shall support these prefixes: gt, lt, ge, le, sa, and eb.

MAY_idtoken

Logical id of this artifact

MAYstatustoken

The status of the Insurance Plan

MAYtypetoken

The type of the Insurance Plan

MAYnamestring

The name of the Insurance Plan

MAYidentifiertoken

The business identifiers of the Insurance Plan

MAYadministered-byreference

Who administers the Insurance Plan

MAYowned-byreference

Who owns the Insurance Plan

MAYnetworkreference

The Insurance Plan network

MAYcoverage-areareference

The Insurance Plan coverage area

MAYbenefit-typetoken

The Insurance Plan type of benefit

 

Resource Conformance: supported EnrollmentRequest

Core FHIR Resource
EnrollmentRequest
Reference Policy
Interaction summary

    Documentation

    FAIS Enroll Beneficiary transaction [ITI-122]

    Extended Operations
    ConformanceOperationDocumentation
    SHALL$submit

    Submits an enrollment request to enroll a new beneficiary with the request coverage. FAIS Enroll Beneficiary transaction [ITI-122]

    Resource Conformance: MAY EnrollmentResponse

    Core FHIR Resource
    EnrollmentResponse
    Reference Policy
    Interaction summary
    • MAY support read, search-type.

    Documentation

    FAIS Check Enrollment Status transaction [ITI-123]

    Search Parameters
    ConformanceParameterTypeDocumentation
    MAY_lastUpdateddate

    When the resource version last changed. The values for this shall support these prefixes: gt, lt, ge, le, sa, and eb.

    MAY_idtoken

    Logical id of this artifact

    MAYstatustoken

    The status of the response

    MAYrequestreference

    The enrollment request

     

    Source

    {
      "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"
            }
          ]
        }
      ]
    }