Skip to content

Latest commit

 

History

History
1082 lines (478 loc) · 16.2 KB

profile-healthcare-member.schema.md

File metadata and controls

1082 lines (478 loc) · 16.2 KB
Raw

Healthcare Member Details Schema

https://ns.adobe.com/xdm/mixins/profile-healthcare-member

Healthcare member details of a person that has or will receive a service or care, such as contact information, primary care physician, and plan information.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted fieldgroups/profile/profile-healthcare-member.schema.json

Schema Hierarchy

  • Healthcare Member Details https://ns.adobe.com/xdm/mixins/profile-healthcare-member

Healthcare Member Details Example

{}

Healthcare Member Details Properties

Property Type Required Defined by
xdm:billingAddress Postal address Optional Personal Contact Details
xdm:faxPhone Phone number Optional Personal Contact Details
xdm:homeAddress Postal address Optional Personal Contact Details
xdm:homePhone Phone number Optional Personal Contact Details
xdm:mailingAddress Postal address Optional Personal Contact Details
xdm:memberDetails object Optional Healthcare Member Details (this schema)
xdm:mobilePhone Phone number Optional Personal Contact Details
xdm:person Person Optional Demographic Details
xdm:personalEmail Email address Optional Personal Contact Details
xdm:shippingAddress Postal address Optional Personal Contact Details
* any Additional this schema allows additional properties

xdm:billingAddress

Billing Address

Billing postal address.

xdm:billingAddress

xdm:billingAddress Type

xdm:faxPhone

Fax Phone

Fax phone number.

xdm:faxPhone

xdm:faxPhone Type

  • Phone number – https://ns.adobe.com/xdm/context/phonenumber

xdm:homeAddress

Home Address

A home postal address.

xdm:homeAddress

xdm:homeAddress Type

xdm:homePhone

Home Phone

Home phone number.

xdm:homePhone

xdm:homePhone Type

  • Phone number – https://ns.adobe.com/xdm/context/phonenumber

xdm:mailingAddress

Mailing Address

Mailing postal address.

xdm:mailingAddress

xdm:mailingAddress Type

xdm:memberDetails

Member

Information about the member.

xdm:memberDetails

  • is optional
  • type: object
  • defined in this schema

xdm:memberDetails Type

object with following properties:

Property Type Required
xdm:dateAgeCollected string Optional
xdm:deceasedDate string Optional
xdm:healthConcerns array Optional
xdm:isDeceased boolean Optional
xdm:plans array Optional
xdm:preferredAvailability string Optional
xdm:prescriptions array Optional
xdm:primaryCarePhysicians array Optional
xdm:specialists array Optional

xdm:dateAgeCollected

Date Age Collected

The date the patient age was collected.

xdm:dateAgeCollected

  • is optional
  • type: string
xdm:dateAgeCollected Type

string

xdm:deceasedDate

Deceased Date

Deceased date if the patient is deceased.

xdm:deceasedDate

  • is optional
  • type: string
xdm:deceasedDate Type

string

xdm:healthConcerns

Health Concerns

Array list of all health concerns

xdm:healthConcerns

  • is optional
  • type: string[]
xdm:healthConcerns Type

Array type: string[]

All items must be of the type: string

xdm:isDeceased

Deceased Indicator

Boolean flag indicating if the member is deceased.

xdm:isDeceased

  • is optional
  • type: boolean
xdm:isDeceased Type

boolean

xdm:plans

Enrolled Plans

undefined

xdm:plans

  • is optional
  • type: object[]
xdm:plans Type

Array type: object[]

All items must be of the type: object with following properties:

Property Type Required
xdm:beneficiaryRelationship string Optional
xdm:billingAccountID string Optional
xdm:coverageEndDate string Optional
xdm:coverageStartDate string Optional
xdm:isActive boolean Optional
xdm:isDependent boolean Optional
xdm:planID string Optional
xdm:primaryMemberID string Optional

xdm:beneficiaryRelationship

Beneficiary Relationship

Beneficiary relationship to the subscriber if the member is a dependent (self, spouse, child, etc).

xdm:beneficiaryRelationship

  • is optional
  • type: string
xdm:beneficiaryRelationship Type

string

xdm:beneficiaryRelationship Known Values
Value Description
self Self
spouse Spouse
child Child
parent Parent

xdm:billingAccountID

Billing Account ID

Unique identifier of the billing account.

xdm:billingAccountID

  • is optional
  • type: string
xdm:billingAccountID Type

string

xdm:coverageEndDate

Coverage End Date

Coverage end date.

xdm:coverageEndDate

  • is optional
  • type: string
xdm:coverageEndDate Type

string

xdm:coverageStartDate

Coverage Start Date

Coverage start date.

xdm:coverageStartDate

  • is optional
  • type: string
xdm:coverageStartDate Type

string

xdm:isActive

Is Active

Boolean flag indicates whether the plan is active.

xdm:isActive

  • is optional
  • type: boolean
xdm:isActive Type

boolean

xdm:isDependent

Is Dependent

Indicates whether this member is a dependent.

xdm:isDependent

  • is optional
  • type: boolean
xdm:isDependent Type

boolean

xdm:planID

Plan Identifier

Unique identifier for the plan enrolled in by the member.

xdm:planID

  • is optional
  • type: string
xdm:planID Type

string

xdm:primaryMemberID

Primary Member ID

Unique identifier of the primary subscriber if the member is a dependent.

xdm:primaryMemberID

  • is optional
  • type: string
xdm:primaryMemberID Type

string

xdm:preferredAvailability

Preferred Availability

Patient's preferred day and time availability for an appointment.

xdm:preferredAvailability

  • is optional
  • type: string
xdm:preferredAvailability Type

string

xdm:prescriptions

Prescriptions

Prescription information including ID, start date, and active flag.

xdm:prescriptions

  • is optional
  • type: object[]
xdm:prescriptions Type

Array type: object[]

All items must be of the type: object with following properties:

Property Type Required
xdm:ID string Optional
xdm:endDate string Optional
xdm:isCurrent boolean Optional
xdm:name string Optional
xdm:numberOfRefills integer Optional
xdm:refillLocation Optional
xdm:refillType string Optional
xdm:startDate string Optional

xdm:ID

Prescription ID

Unique identifier for the prescription.

xdm:ID

  • is optional
  • type: string
xdm:ID Type

string

xdm:endDate

Prescription End Date

Date on which the patient stops taking the prescription.

xdm:endDate

  • is optional
  • type: string
xdm:endDate Type

string

xdm:isCurrent

Is Current

Indicates whether the prescription is current or past.

xdm:isCurrent

  • is optional
  • type: boolean
xdm:isCurrent Type

boolean

xdm:name

Prescription Name

Name of the prescription.

xdm:name

  • is optional
  • type: string
xdm:name Type

string

xdm:numberOfRefills

Number Of Refills

Number of refills prescribed by the provider for this prescription.

xdm:numberOfRefills

  • is optional
  • type: integer
xdm:numberOfRefills Type

integer

xdm:refillLocation

Prescription Refill Location

Address at which the prescription will be filled.

xdm:refillLocation

  • is optional
  • type: reference
xdm:refillLocation Type
  • – https://ns.adobe.com/xdm/common/address

xdm:refillType

Refill Type

Type of prescription refill.

xdm:refillType

  • is optional
  • type: string
xdm:refillType Type

string

xdm:refillType Known Values
Value Description
Retail Pharmacy Retail Pharmacy
Mail Order Mail Order

xdm:startDate

Prescription Start Date

Date on which the patient began taking the prescription.

xdm:startDate

  • is optional
  • type: string
xdm:startDate Type

string

xdm:primaryCarePhysicians

undefined

xdm:primaryCarePhysicians

  • is optional
  • type: object[]
xdm:primaryCarePhysicians Type

Array type: object[]

All items must be of the type: object with following properties:

Property Type Required
xdm:endDate string Optional
xdm:firstName string Optional
xdm:healthNetworkAffiliation array Optional
xdm:lastName string Optional
xdm:providerID string Optional
xdm:startDate string Optional

xdm:endDate

End Date

Date on which the PCP ended care for the member.

xdm:endDate

  • is optional
  • type: string
xdm:endDate Type

string

xdm:firstName

First Name

Primary care physician's first name.

xdm:firstName

  • is optional
  • type: string
xdm:firstName Type

string

xdm:healthNetworkAffiliation

Health Network Affiliation

Name of the health network to which the Primary Care Provider is affiliated.

xdm:healthNetworkAffiliation

  • is optional
  • type: string[]
xdm:healthNetworkAffiliation Type

Array type: string[]

All items must be of the type: string

xdm:lastName

Last Name

Primary care physician's last name.

xdm:lastName

  • is optional
  • type: string
xdm:lastName Type

string

xdm:providerID

Provider ID

Unique identifier of the physician.

xdm:providerID

  • is optional
  • type: string
xdm:providerID Type

string

xdm:startDate

Start Date

Date on which the primary care provider began care for the member.

xdm:startDate

  • is optional
  • type: string
xdm:startDate Type

string

xdm:specialists

Specialist

undefined

xdm:specialists

  • is optional
  • type: object[]
xdm:specialists Type

Array type: object[]

All items must be of the type: object with following properties:

Property Type Required
xdm:firstName string Optional
xdm:lastName string Optional
xdm:providerID string Optional
xdm:specialty array Optional

xdm:firstName

first Name

First name of the specialist provider.

xdm:firstName

  • is optional
  • type: string
xdm:firstName Type

string

xdm:lastName

last Name

Last name of the specialist provider.

xdm:lastName

  • is optional
  • type: string
xdm:lastName Type

string

xdm:providerID

Provider ID

Unique identifier of the specialist.

xdm:providerID

  • is optional
  • type: string
xdm:providerID Type

string

xdm:specialty

Specialty

Specialty of the provider (anesthesiology, urology, radiology, dermatology, etc).

xdm:specialty

  • is optional
  • type: string[]
xdm:specialty Type

Array type: string[]

All items must be of the type: string

xdm:mobilePhone

Mobile Phone

Mobile phone number.

xdm:mobilePhone

xdm:mobilePhone Type

  • Phone number – https://ns.adobe.com/xdm/context/phonenumber

xdm:person

Person

An individual actor, contact, or owner.

xdm:person

xdm:person Type

  • Person – https://ns.adobe.com/xdm/context/person

xdm:personalEmail

Personal Email

A personal email address.

xdm:personalEmail

xdm:personalEmail Type

  • Email address – https://ns.adobe.com/xdm/context/emailaddress

xdm:shippingAddress

Shipping Address

Shipping postal address.

xdm:shippingAddress

xdm:shippingAddress Type