A Group represents a collection of members - frequently a single employer group.\

Endpoint

https://platform.wellviasolutions.com/organization/v1/group\

The Group Object

Attributes

id string: required

The unique identifier of the group.

clientId string: required

The unique identifier of the client that the group belongs to.

name string: required

The displayed name of the group.

serviceOfferings list of objects: required

A list of the different service offerings the group has access to.

id string: required

The unique identifier of the service offering.

planDesigns list of objects: required

A list of the different services included and their respective pricing and configurations.

visitType string: required

The unique type identifier specifying the type of visit. See the Visit Type Dictionary for possible values.

requireRTELookup boolean: required

Specifies if a real-time eligibility lookup (EDI 270) is required when the member requests this service.

applyDeductibleLogic boolean: required

Specifies if the member's deductible is to be taken into consideration for the visit fee.

applyCoInsuranceLogic boolean: required

Specifies if the member's co-insurance is to be taken into consideration for the visit fee.

memberFee decimal: optional

The amount to be paid by the member before any additional discounts, deductibles, or other considerations are taken into account. This should be considered as a "default" fee.

memberFeeBeforeDeductibleMet decimal: optional

The amount to be paid by the member before their deductible has been met.

memberFeeAfterDeductibleMet decimal: optional

The amount to be paid by the patient after their deductible has been met.

thirdPartyFeeBeforeDeductibleMet decimal: optional

The amount to be paid by the payer (or other responsible party) before the members' deductible has been met.

thirdPartyFeeAfterDeductibleMet decimal: optional

The amount to be paid by the payer (or other responsible party) after the members' deductible has been met.

totalFee decimal: optional

The total amount to be billed for this visit type.

billingAmount decimal: required

The access fee to be paid for this service offering at the frequency of the billingCycle.

billingCycle string: required

The frequency in which the sponsor will be billed the billingAmount. See the Billing Cycle Type Dictionary for possible values.

alternativeIds dictionary: required

A dictionary containing alternative identifiers for this service offering.

key string: required

A unique value that represents the service offering. This is frequently a known value to the client and can be used to identify the required id for other API requests.

value string: required

A value that represents the service offering identifier type. See the Service Offering Identifier Type Dictionary for possible values.

isEnabled boolean: required

Specifies if the group is active and members have access to services.

alternativeIds list of strings: required

Additional unique alternative identifiers for the group.

startDate timestamp: optional

The date the group is activated for service.

endDate timestamp: optional

The date the group is termed from service.

alternativeTreatmentMethodCost dictionary: required

The alternative treatment cost of services for this group.

key string: required

The unique type of alternative treatment. See the Service Offering Identifier Type Dictionary for possible values.

value decimal: required

The dollar amount representing the typical cost of treatment.

fulfillment object: required

An object containing details around email and hard-copy fulfillment for the group.

emailFulfillment boolean: required

Specifies if welcome emails are sent out to new members when they are created.

hardCopyFulfillment boolean: required

Specifies if ID cards are mailed to new members when they are created.

Example

{
	"id": "94534",
	"clientId": "123456",
	"name": "Todd's Tacos",
	"serviceOfferings": [
		{
			"id": "123",
			"planDesigns": [
				{
					"visitType": "generalmedical",
					"requireRTELookup": false,
					"applyDeductibleLogic": false,
					"applyCoInsuranceLogic": true,
					"memberFee": 0.00,
					"memberFeeBeforeDeductibleMet": null,
					"memberFeeAfterDeductibleMet": null,
					"thirdPartyFeeBeforeDeductibleMet": null,
					"thirdPartyFeeAfterDeductibleMet": null,
					"totalFee": null
				},
				{
					"visitType": "dermatologyinitial",
					"requireRTELookup": false,
					"applyDeductibleLogic": false,
					"applyCoInsuranceLogic": true,
					"memberFee": 0.00,
					"memberFeeBeforeDeductibleMet": null,
					"memberFeeAfterDeductibleMet": null,
					"thirdPartyFeeBeforeDeductibleMet": null,
					"thirdPartyFeeAfterDeductibleMet": null,
					"totalFee": null
				},
				{
					"visitType": "therapycounseling",
					"requireRTELookup": false,
					"applyDeductibleLogic": false,
					"applyCoInsuranceLogic": true,
					"memberFee": 0.00,
					"memberFeeBeforeDeductibleMet": null,
					"memberFeeAfterDeductibleMet": null,
					"thirdPartyFeeBeforeDeductibleMet": null,
					"thirdPartyFeeAfterDeductibleMet": null,
					"totalFee": null
				}
			],
			"billingAmount": 10.0000,
			"billingCycle": "monthly",
			"alternativeIds": {
				"A": "offeringcode",
				"1c2e2dce948c4350b8b1a1dea67f": "clientserviceofferingid"
			}
		},
		{
			"id": "456",
			"planDesigns": [
				{
					"visitType": "generalmedical",
					"requireRTELookup": false,
					"applyDeductibleLogic": false,
					"applyCoInsuranceLogic": true,
					"memberFee": 40.00,
					"memberFeeBeforeDeductibleMet": null,
					"memberFeeAfterDeductibleMet": null,
					"thirdPartyFeeBeforeDeductibleMet": null,
					"thirdPartyFeeAfterDeductibleMet": null,
					"totalFee": null
				}
			],
			"billingAmount": 5.0000,
			"billingCycle": "monthly",
			"alternativeIds": {
				"B": "offeringcode",
				"a16d7230ba3aadae629e99811de0": "clientserviceofferingid"
			}
		}
	],
	"isEnabled": true,
	"alternativeIds": [
		"TT01"
	],
	"startDate": "2022-05-27T00:00:00",
	"endDate": null,
	"alternativeTreatmentMethodCost": {
		"primarycare": 100.0000,
		"specialist": 130.0000,
		"emergencyroom": 1000.0000,
		"urgentcare": 155.0000
	},
	"fulfillment": {
		"emailFulfillment": false,
		"hardCopyFulfillment": false
	}
}