### Practitioner Resource Example Source: https://build.fhir.org/ig/HL7/carin-bb/Practitioner-Practitioner1 This snippet provides an example of a Practitioner resource conforming to the CARIN BB implementation guide. ```APIDOC ## GET /Practitioner/{id} ### Description Retrieves a specific Practitioner resource by its ID. ### Method GET ### Endpoint /Practitioner/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the Practitioner resource. ### Response #### Success Response (200) - **resourceType** (string) - The resource type, which is 'Practitioner'. - **id** (string) - The unique identifier for the Practitioner. - **meta** (object) - Metadata about the resource, including last updated time and profile information. - **text** (object) - A narrative representation of the resource. - **identifier** (array) - An array of identifiers for the Practitioner (e.g., NPI). - **active** (boolean) - Indicates if the practitioner is active. - **name** (array) - The name of the practitioner, including family, given, and prefix. #### Response Example ```json { "resourceType" : "Practitioner", "id" : "Practitioner1", "meta" : { "lastUpdated" : "2020-05-04T03:02:01-04:00", "profile" : ["http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Practitioner|2.1.0"] }, "text" : { "status" : "generated", "div" : "

Generated Narrative: Practitioner Practitioner1

Last updated: 2020-05-04 03:02:01-0400

Profile: C4BB Practitionerversion: null2.1.0)

identifier: National Provider Identifier/9941339100

active: true

name: John Smith

Generated Narrative: Organization ProviderTransportationOrganization1

Last updated: 2020-05-04 03:02:01-0400

Profile: C4BB Organizationversion: null2.1.0)

identifier: National Provider Identifier/9941339100

active: true

name: ABC Ambulance Services

address: Attn: ABC Ambulance Services Pittsburgh PA 15222 USA

Contacts

-	Telecom
*	ph: 555-555-5511(Work)

Generated Narrative: Coverage Coverage2

Last updated: 2020-10-30 09:48:01-0400; Language: en-US

Profile: C4BB Coverageversion: null2.1.0)

identifier: An identifier for the insured of an insurance policy (this insured always has a subscriber), usually assigned by the insurance carrier./88800933501

status: Active

policyHolder: Johnny Example1 Male, DoB: 1986-01-01 ( Member Number)

subscriber: Johnny Example1 Male, DoB: 1986-01-01 ( Member Number)

subscriberId: 888009335

beneficiary: Johnny Example1 Male, DoB: 1986-01-01 ( Member Number)

dependent: 01

relationship: Self

period: 2017-01-01 --> 2017-06-30

payor: UPMC Health Plan

class
type: An employee group
value: MCHMO1
name: MEDICARE HMO PLAN

class
type: A specific suite of benefits.
value: GI8
name: GI8-HMO DEDUCTIBLE

network: GI8-HMO DEDUCTIBLE

" }, "identifier" : [ { "type" : { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "MB", "display" : "Member Number" } ], "text" : "An identifier for the insured of an insurance policy (this insured always has a subscriber), usually assigned by the insurance carrier." }, "system" : "https://www.upmchealthplan.com/fhir/memberidentifier", "value" : "88800933501", "assigner" : { "reference" : "Organization/Payer2", "display" : "UPMC Health Plan" } } ], "status" : "active", "policyHolder" : { "reference" : "Patient/Patient1" }, "subscriber" : { "reference" : "Patient/Patient1" }, "subscriberId" : "888009335", "beneficiary" : { "reference" : "Patient/Patient1" }, "dependent" : "01", "relationship" : { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/subscriber-relationship", "code" : "self" } ], "text" : "Self" }, "period" : { "start" : "2017-01-01", "end" : "2017-06-30" }, "payor" : [ { "reference" : "Organization/Payer2", "display" : "UPMC Health Plan" } ], "class" : [ { "type" : { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/coverage-class", "code" : "group", "display" : "Group" } ], "text" : "An employee group" }, "value" : "MCHMO1", "name" : "MEDICARE HMO PLAN" }, { "type" : { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/coverage-class", "code" : "plan", "display" : "Plan" } ], "text" : "A specific suite of benefits." }, "value" : "GI8", "name" : "GI8-HMO DEDUCTIBLE" } ], "network" : "GI8-HMO DEDUCTIBLE" } ``` -------------------------------- ### Coverage Resource Example (CARIN BB) Source: https://build.fhir.org/ig/HL7/carin-bb/Coverage-CoverageDental1 An example of a FHIR Coverage resource conforming to the CARIN Blue Button profile, illustrating dental coverage details. ```APIDOC ## GET /websites/build_fhir_ig_hl7_carin-bb/Coverage/CoverageDental1 ### Description Retrieves a specific Coverage resource. ### Method GET ### Endpoint /websites/build_fhir_ig_hl7_carin-bb/Coverage/CoverageDental1 ### Request Example ```json { "resourceType" : "Coverage", "id" : "CoverageDental1", "meta" : { "lastUpdated" : "2021-01-01T14:22:01.0314215+00:00", "profile" : ["http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage|2.1.0"] }, "language" : "en-US", "text" : { "status" : "generated", "div" : "

Generated Narrative: Coverage CoverageDental1

Last updated: 2021-01-01 14:22:01+0000; Language: en-US

Profile: C4BB Coverageversion: null2.1.0)

identifier: Member Number/210300002

status: Active

type: dental care policy

policyHolder: Member 01 Test Male, DoB: 1943-01-01 ( An identifier for the insured of an insurance policy (this insured always has a subscriber), usually assigned by the insurance carrier.:\u00a088800933501)

subscriber: Member 01 Test Male, DoB: 1943-01-01 ( An identifier for the insured of an insurance policy (this insured always has a subscriber), usually assigned by the insurance carrier.:\u00a088800933501)

subscriberId: 10300007

beneficiary: Member 01 Test Male, DoB: 1943-01-01 ( An identifier for the insured of an insurance policy (this insured always has a subscriber), usually assigned by the insurance carrier.:\u00a088800933501)

dependent: 01

relationship: Self

period: 2021-01-01 --> 2021-12-31

payor: Organization INSURANCE COMPANY XYZ

class
type: An employee group
value: 10300007
name: Transcorp - dental

class
type: Plan
value: 66783JJT
name: INSURANCE COMPANY XYZ - PRIME

network: INSURANCE COMPANY XYZ - PRIME

Generated Narrative: Coverage CoverageDental1

Last updated: 2021-01-01 14:22:01+0000; Language: en-US

Profile: C4BB Coverageversion: null2.1.0)

identifier: Member Number/210300002

status: Active

type: dental care policy

subscriberId: 10300007

dependent: 01

relationship: Self

period: 2021-01-01 --> 2021-12-31

payor: Organization INSURANCE COMPANY XYZ

class
type: An employee group
value: 10300007
name: Transcorp - dental

class
type: Plan
value: 66783JJT
name: INSURANCE COMPANY XYZ - PRIME

network: INSURANCE COMPANY XYZ - PRIME

" }, "identifier" : [ { "type" : { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "MB" } ] }, "system" : "https://www.xxxhealthplan.com/fhir/memberidentifier", "value" : "210300002" } ], "status" : "active", "type" : { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code" : "DENTAL" } ], "text" : "dental care policy" }, "policyHolder" : { "reference" : "Patient/Patient2" }, "subscriber" : { "reference" : "Patient/Patient2" }, "subscriberId" : "10300007", "beneficiary" : { "reference" : "Patient/Patient2" }, "dependent" : "01", "relationship" : { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/subscriber-relationship", "code" : "self" } ] }, "period" : { "start" : "2021-01-01", "end" : "2021-12-31" }, "payor" : [ { "reference" : "Organization/DentalPayer1" } ], "class" : [ { "type" : { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/coverage-class", "code" : "group" } ], "text" : "An employee group" }, "value" : "10300007", "name" : "Transcorp - dental" }, { "type" : { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/coverage-class", "code" : "plan" } ], "text" : "Plan" }, "value" : "66783JJT", "name" : "INSURANCE COMPANY XYZ - PRIME" } ], "network" : "INSURANCE COMPANY XYZ - PRIME" } ``` ``` -------------------------------- ### Organization Resource Example Source: https://build.fhir.org/ig/HL7/carin-bb/Organization-ProviderOrganization5 This snippet shows an example of a FHIR Organization resource adhering to the CARIN BB profile. ```APIDOC ## GET /Organization/{id} ### Description Retrieves a specific Organization resource by its ID. ### Method GET ### Endpoint /Organization/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the Organization resource. ### Response #### Success Response (200) - **resourceType** (string) - The type of the resource, always 'Organization'. - **id** (string) - The unique identifier of the Organization resource. - **meta** (object) - Metadata about the resource, including last updated timestamp and profile information. - **text** (object) - A narrative representation of the resource. - **identifier** (array) - A list of identifiers for the organization. - **active** (boolean) - Indicates if the organization is active. - **name** (string) - The name of the organization. - **address** (array) - An array of addresses associated with the organization. - **contact** (array) - An array of contact details for the organization. #### Response Example ```json { "resourceType" : "Organization", "id" : "ProviderOrganization5", "meta" : { "lastUpdated" : "2020-05-04T03:02:01-04:00", "profile" : ["http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization|2.1.0"] }, "text" : { "status" : "generated", "div" : "

Generated Narrative: Organization ProviderOrganization5

Last updated: 2020-05-04 03:02:01-0400

Profile: C4BB Organizationversion: null2.1.0)

identifier: National Provider Identifier/9941339100

active: true

name: Black Medical Group

address: Attn: Black Medical Group Pittsburgh PA 15222 USA

Contacts

-	Telecom
*	ph: 555-555-5560(Work)

" }, "identifier" : [ { "type" : { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "NPI", "display" : "National Provider Identifier" } ], "text" : "National Provider Identifier" }, "system" : "http://hl7.org/fhir/sid/us-npi", "value" : "9941339100" } ], "active" : true, "name" : "Black Medical Group", "address" : [ { "line" : ["Attn: Black Medical Group"], "city" : "Pittsburgh", "state" : "PA", "postalCode" : "15222", "country" : "USA" } ], "contact" : [ { "telecom" : [ { "system" : "phone", "value" : "555-555-5560", "use" : "work" } ] } ] } ``` ``` -------------------------------- ### Organization Resource Example Source: https://build.fhir.org/ig/HL7/carin-bb/Organization-DentalPayer1 An example of a FHIR Organization resource conforming to the CARIN BB profile. ```APIDOC ## GET /websites/build_fhir_ig_hl7_carin-bb/Organization/DentalPayer1 ### Description This endpoint retrieves a specific Organization resource identified by its ID, conforming to the CARIN BB profile. ### Method GET ### Endpoint /websites/build_fhir_ig_hl7_carin-bb/Organization/DentalPayer1 ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the Organization resource to retrieve. ### Request Example ``` GET /websites/build_fhir_ig_hl7_carin-bb/Organization/DentalPayer1 HTTP/1.1 Host: example.com Accept: application/json ``` ### Response #### Success Response (200) - **resourceType** (string) - The type of the resource (Organization). - **id** (string) - The unique identifier for the Organization resource. - **meta** (object) - Metadata about the resource, including last updated time and profile conformance. - **lastUpdated** (dateTime) - The date and time the resource was last updated. - **profile** (array) - A list of profiles that the resource conforms to. - **language** (string) - The primary language of the content. - **text** (object) - A human-readable summary of the resource. - **status** (string) - The status of the narrative (generated). - **div** (string) - The HTML content of the narrative. - **identifier** (array) - An array of identifiers for the organization. - **type** (object) - The type of identifier. - **coding** (array) - A list of codes that identify the type of identifier. - **system** (uri) - The namespace for the identifier type code. - **code** (string) - The identifier type code. - **system** (uri) - The namespace for the identifier value. - **value** (string) - The identifier value. - **active** (boolean) - Indicates if the organization is active. - **name** (string) - The name of the organization. #### Response Example ```json { "resourceType" : "Organization", "id" : "DentalPayer1", "meta" : { "lastUpdated" : "2021-01-01T10:23:11+00:00", "profile" : ["http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization|2.1.0"] }, "language" : "en-US", "text" : { "status" : "generated", "div" : "

Generated Narrative: Organization DentalPayer1

Last updated: 2021-01-01 10:23:11+0000; Language: en-US

Profile: C4BB Organizationversion: null2.1.0)

identifier: National provider identifier/9941339100, Payer ID/66783JJT

active: true

name: INSURANCE COMPANY XYZ

" }, "identifier" : [ { "type" : { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "NPI" } ] }, "system" : "http://hl7.org/fhir/sid/us-npi", "value" : "9941339100" }, { "type" : { "coding" : [ { "system" : "http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType", "code" : "payerid" } ] }, "value" : "66783JJT" } ], "active" : true, "name" : "INSURANCE COMPANY XYZ" } ``` ```