Office of the National Coordinator for Health IT Standards Interoperability Framework Electronic Service Information Discovery Data Model

(1)

Electronic Service Information Discovery Data Model

1 Object Data Set - data elements and definitions for all data objects

2 Response Data Set - data elements for response transactions

3 Query Data Set - data elements for query transactions

4 Data model assumptions

5 Query and Response Descriptions and Examples - detailed overview of valid query and response transactions

1 ESI IntegrationProfile examples

2 ESI ContentProfile examples

3 ESI SecurityProfile examples

DATA MODEL OVERVIEW

The Electronic Service Information Discovery Data Model includes the following components:

Items 1 thru 4 are worksheets embedded within this workbook. Item 5 is a separate Excel document.

Three worksheets are included in this document to help clarify objects within the data model. While users of the data model are

encouraged to review these supporting materials, they

are not

in and of themselves part of the data model. The supporting materials

include:

Worksheet: Data Model Overview

Version: Final

1 / 14

Provider Directories Initiative

Electronic Service Information Workgroup

(2)

Name of Data Element Definition of Data Element Data type Occurrence(s) Comments/Notes Standard Format / Vocabulary

The Address Object contains a single physical (postal) address

Internationalization is currently out of scope. To be considered as necessary later. (address, telephone number, name)

Address line 1 First line of an address String 1

Address line 2 Second line of an address, if needed String 0,1

City Contains a valid US city String 1 Valid US city

County Contains a valid US county String 0,1 Valid list of US counties

State Two digit state abbreviation String 1 Recommend vocabulary to make this an encoded value -- valid city based on USPO

ZIP Code Five digit ZIP code with optional extension String 1 From list of US ZIP codes from USPO

Usage

Indicates the usage for this address. Valid values are:

a) practice - the address at which healthcare services are provided

b) mailing - the address to send general mail c) payment - the address to sent payment and billing issues

d) legal - the address to which legal communication should be directed.

String 1

List 1

Practice location, Mailing, Payment, Legal

Telephone Number Telephone number in standard telephone format

(aaa) nnn-nnnn String 1 Standard telephone format (aaa) nnn-nnnn

Usage

Indicates the usage for this number. Valid values are: a) business

b) mobile c) pager d) fax

String 1 List 2

Business, Mobile, Pager, Fax

Individual First Name First Name or Given Name of the individual String 1 For names, suggest support for Soundex, partial string, and wild card

Individual Middle Name Middle Name or Initial of the individual String 0,1 For names, suggest support for Soundex, partial string, and wild card

Individual Last Name Last Name or Family Name of the individual String 1 For names, suggest support for Soundex, partial string, and wild card

Individual Prefix Honorary title String 0,1 Honorary title, example Dr., Sister

Individual Suffix Generational Identifier String 0,1 Generational identifier, example Jr., Sr., II

State Issuing Two digit state abbreviation which issued the license String 1 Standard state abbreviations (e.g. CA)

Issuing Authority The name of the authority issuing the license String 1

Address Object

Telephone Number Object

Individual Name Object

State License Object

OBJECT DATA SET

Worksheet: Object Data Set

Version: Final 2 / 14

Provider Directories Initiative Electronic Service Information Workgroup

(3)

License Type Describes what the individual is licensed to practice,

for example: physician, nurse, dental, therapist, etc. String 1 Recommend usage from enumerated List 3

List 3

Physician, Nurse, Dental, Therapist, Pharmacist, Optician, Midwife, Medical Assistant, Allied Health, Other

License Number The number assigned by the Issuing Authority for this

license String 1

Year Issued Four digit year the Issuing Authority issued this

license for this individual Integer 1 Valid year

Status Status of the license: active, inactive, revoked

suspended String 0,1

List 4

Active, Inactive, Revoked, Suspended

Granting Institution The formal name of the institution granting the

professional degree String 1

Degree Code representing the degree granted as defined in

the code set String 1

List 5

MD, DO, DC, PhD, BS, BA, MPH, MS, MA, RN, LVN, LPT, OTR, AuD, OD

Year Granted Four digit year degree was granted Integer 1 Valid year

State Certifying State certifying assuming it is a state based certifying

authority, otherwise state is not required String 0,1 Standard state abbreviations (e.g. CA)

Certifying Authority Name of Certifying authority as it appears on the

certification String 1 e.g. American Board of Internal Medicine

Certificate Type Name of the certification as defined by the certifying

authority String 1 e.g. Fellow in Endocrinology

Certificate Number Certificate number assigned by the certifying authority String 1

Year Granted Four digit year certification was granted Integer 1

Policy Name Name of the Policy as defined by the community,

state or federal governance, or policy authority String 1

Policy Information may contain elements related to the presence or absence of a DURSA or other policy related agreements

Computable policy object Placeholder for a URL pointing to a "to be defined"

Computable Policy Object URL 0,1

Planning for future effort to define meta data associated with policies to automate the sharing/disclosure of data

Policy Document Address Contains a URL address to where a human readable

policy document can be found URL 0,1

Policy Document Electronic copy of policy in PDF format Binary Object 0,1

Unique ID for Electronic Service Information

An identifier assigned by the provider directory whose purpose is to uniquely identify a unique ESI for an individual, organization, individual-organization relationship.

String 1

An electronic service is a new unique endpoint. A new unique electronic service should be created for each electronic address in which the data elements differ.

IntegrationProfile A coded value which identifies the Integration Profile

which describes the transport and valid contents String/Coded 1

See IntegrationProfile examples tab "Value" column for representative examples of coded elements and descriptions/constraints.

Professional Degree Object

Certification Object

Policy Information Object

Electronic Service Information Object

(4)

IntegrationProfileVersion The version(s) of the Integration Profile supported String 0..n

See IntegrationProfile examples tab for representative examples of coded versions for each Integration Profile and descriptions/constraints.

IntegrationProfileOptions Options defined for the specific Integration Profile String/Coded 0..n Defined by the specific implementation guide

ContentProfile Object An object that identifies, if appropriate, the Content

Profile supported by the service. Object 0..n

See ContentProfile examples tab for representative examples of coded elements and descriptions.

SecurityProfile Object An object that identifies, if appropriate, the Security

Profile supported by the service. Object 0..n

See SecurityProfile examples tab for representative examples of coded elements and descriptions

Address The address of the Electronic Service String 1 The Integration Profile identified will define the format of this value

Preferred Method

Integer between 0 and 99 indicating the preferred order of the service, where 0 is the most preferred service and 99 is the least preferred

Numeric, 2

digit 0,1

ContentProfile A coded value that identifies, if appropriate, the

Content Profile supported by the service. String/Coded 1

See the ContentProfile examples tab for representative examples of coded elements and descriptions.

ContentProfileVersion The version(s) of the Content Profile supported String 0..n

See the ContentProfile examples tab for representative examples of coded versions for each ContentProfile and descriptions/options.

ContentProfileConstraints A coded value that identifies, if appropriate, additional

constraints on this Content Profile String/Coded 0..n

See the ContentProfile examples tab for representative examples of coded elements and descriptions.

SecurityProfile An coded value that identifies, if appropriate, the

Security Profile supported by the service. String/Coded 1

See the SecurityProfiile examples tab for representative examples of coded elements and descriptions

SecurityProfileVersion Version(s) of the Security Profile supported String 0..n

See the SecurityProfile examples tab for representative examples of coded versions for each SecurityProfile and descriptions/constraints

SecurityProfileConstraints A coded value that identifies, if appropriate,

constraints supported by this SecurityProfile String/Coded 0..n

See the SecurityProfile examples tab for representative examples of coded elements and descriptions

SecurityProfile Object

ContentProfile Object

(5)

Individual ID

An identifier assigned by the provider directory whose purpose is to uniquely identify an individual record within this provider directory.

String 1

Return of this information assumes that the query included information from the Individual Section or a unique reference for the individual

Alternate Individual Identifier An identifier, usually unique , associated with this Individual ID String 0..n May be any alternative identifier, including an OID.

Individual Record Status Status of the Individual String 1 Valid values are "active" or "inactive" "retired" and "deceased"

Legal Individual Name

Legal name of the individual - see Individual Name Object (for individuals, this is the name on the birth certificate or naturalization forms or as legally changed)

Object 1

Alternate/Other Known Individual Names

Alternative or other names used by the individual - see

Individual Name Object Object 0..n

Individual Provider Type Code to define type of provider based on standard code set Code 0..n ISO 21298

Individual Specialty Specialty of Individual Code 0..n ISO 21298 or provider taxonomy code sets

Individual Gender Gender of Individual String 0,1 Set of "M", "F", no entry or null would be used for unknown or indeterminate

Date of Birth Birthdate of individual Date 0,1

Individual Address Object Physical Addresses for the individual - see Address Object Object 0..n

Individual Telephone Object Telephone numbers for the Individual - See Telephone Number

Object Object 0..n

Individual NPI NPI assigned by NPPES NPI Registry Integer 0,1 Single NPI for a person - Single Type 1 NPI

Individual Certification List of certifications held by the individual - see Certification

Object Object 0..n

Individual State License List of state licenses held by the individual - see State License

Object Object 0..n

Individual Professional Degree List of professional degrees held by the individual - see

Professional Degree Object Object 0..n

Individual Email Email addresses used by the individual (other than for Direct) String 0..n

Individual Electronic Service Information

Description of electronic services provided by the individual -

see Electronic Service Information Object Object 0..n

Individual Public Digital Certificate A base 64 encoded representation of the public digital certificate String 0..n This is a list of organization public digital certificates

Individual Digital Certificate ID Serial number from the public digital certificate String 0..n This is a list of digital certificate Serial Numbers for all individual public digital certificates

Individual Digital Certificate

Distinguished Name Distinguished Name field from digital certificate String 0..n

This is a list of digital certificate Distinguished Names for all Individual Public Digital Certificates

Organization ID

An identifier assigned by the provider directory whose purpose is to uniquely identify an organization record within this provider directory.

String 1

Alternate Organizational Identifier An identifier, usually unique , associated with this Organization

ID String 0..n May be any alternative identifier, including an OID.

Organizational Record Status Status of the Organization String 1 Valid values are "active" or "inactive"

RESPONSE DATA SET

While not required, it is highly recommended that all individuals/organizations have a valid ESI.

Individual

While most individual data elements are not required, it is recommended that individuals have sufficient data elements defined to aid in disambiguation.

Organization

Worksheet: Response Data Set

(6)

Organization Legal Name Legal name of the organization String 0,1 Legal name of organization if this Organization ID has a legal name

Organization Alias Alternate names for the organization String 0..n Includes DBA's and non-legal names such as departments or roles

Organization Address Object Physical addresses of the Organization - see Address Object Object 1..n For name and address, suggest support for partial string (check with use case)

Organization Type Type of the organization String 1..n For Organization type from ISO 21298

Organization Telephone Object Telephone numbers for the organization - see Telephone

Number Object Object 1..n

Organization NPI National provider identifier issued to the organization String 0..n Issued by NPPES

Organization Certification Object Certifications held by the organization - see Certification Object Object 0..n

Organization Specialty Specialty of the Organization String 0..n

Standard Code Sets for Specialty (example: Healthcare Provider Taxonomy Code Set) -- note added to agree with query (ISO 21298)

Organization Policy Information Policies supported by the Organization - see Policy Information

Object Object 0..n

Organization Email Emails for the organization (other than Direct) String 0..n

Organization Electronic Service Information Object

Description of electronic services provided by the Organization -

see Electronic Service Information Object Object 0..n

Organization Public Digital

Certificate A base 64 encoded representation of the public digital certificate String 0..n This is a list of organization public digital certificates Organization Digital Certificate ID Serial number from the public digital certificate String 0..n This is a list of digital certificate serial numbers for all

organization public digital certificates

Organization Digital Certificate

This is a list of digital certificate Distinguished Names for all organization Public Digital Certificates

Individual ID Individual ID (see Individual) String 1

Organization ID Organization ID (see Organization) String 1

Telephone Object

Telephone numbers used by the individual referenced by Individual ID when associated with the organization referenced by Organization ID - see Telephone Number Object

Object 0..n

Individual-Organization Email

Email addresses (other than Direct) used by the individual referenced by Individual ID when associated with the organization referenced by Organization ID

String 0..n

Electronic Service Information Object

Describes electronic services supported by the individual when associated with the organization - see Electronic Service Information Object

Object 0..n

Organization Public Digital

Certificate A base 64 encoded representation of the public digital certificate String 0..n This is a list of organization public digital certificates Organization Digital Certificate ID Serial number from the public digital certificate String 0..n This is a list of digital certificate serial numbers for all

organization public digital certificates

Organization Digital Certificate

This is a list of digital certificate Distinguished Names for all Organization Public Digital Certificates

Parent Organization ID Organization ID (see Organization) of the parent String 1

Child Organization ID Organization ID (see Organization) of the child String 1

Individual – Organization Relationship

Organization – Organization Relationship

(7)

Provider Directory ID

An identifier assigned to the provider directory whose purpose is to uniquely identify the provider directory from which a set of data is retuned.

String 1

These data elements must provide a means for a query response to indicate the provider directory that is the source of the response.

Provider Directory Name The name associated with the Provider Directory String 1

Provider Directory

(8)

Individual ID As defined in the Response Data Set String 0,1

Allows query for specific Individual data set and/or limits Organization data set retrieval to those with a relationship with the selected Individual ID

Alternate Individual Identifier As defined in the Response Data Set String 0..n Allows query by alternate, usually unique, identifiers such as OIDs

Legal Individual Name As defined in the Response Data Set Object 0,1

Query may include any of the individual name object data set elements. For names, suggest support for Soundex, partial string, and wild card.

Alternate/Other Known Individual

Names As defined in the Response Data Set Object 0,1

Query may include any of the Individual Name Object data set elements.

Individual Provider Type As defined in the Response Data Set String 0..n By selected item in code set ISO21298

Individual Gender Gender of Individual String 0,1 Set of "M", "F", no entry or null would be used for unknown or indeterminate

Individual Specialty Specialty of Individual String 0..n ISO 21298 or provider taxonomy code sets

Individual Address Object See the Address Object Object 0..n Query may include any of the Address Object data elements. Individual Telephone Number As defined in Telephone Number Object Object 0..n Query may include any of the Telephone Number Object data set

elements. Individual NPI NPI assigned by NPPES NPI Registry Integer 0,1 Issued by NPPES

Individual Email Individual Email String 0..n Query may include any of the Email Object data set elements. Individual Electronic Service

Information See Electronic Service Information Object Object 0..n

Query may include any of the Individual Electronic Address Object elements.

Individual Digital Certificate ID As defined in the Response Data Set String 0..n This is a query field for a unique Digital Certificate serial number. Individual Digital Certificate

distinguished name As defined in the Response Data Set String 0..n This is a query field for a unique Digital Certificate distinguished name. Individual Professional Degree Object See Professional Degree Object Object 0..n Query may include any of the Professional Degree Object data

elements.

Individual State License Object See State License Object Object 0..n Query may include any of the State License Object data elements. Individual Certification Object See Certification Object Object 0..n Query may include any of the Certification Object data elements.

Organization ID As defined in the Response Data Set String 0,1

Allows query for specific Organization data object and/or limits Individual data set retrieval to those with a relationship with the selected Organization ID

Alternate Organization Identifier As defined in the Response Data Set String 0..n Allows query by alternate, usually unique, identifiers such as OIDs Organization legal name Legal organization name String 0,1

Organization Alias Alternate names for the organization String 0,1 Includes DBA's

Organization Address Object See Address Object Object 0..n Query may include any of the Address Object data elements. For name and address, suggest support for partial string

Organization Type As defined in the Response Data Set String 0..n By selected item in code set

Telephone As defined in the Telephone Number Object String 0..n Query may include any of the Telephone Number Object data elements.

Organization NPI National provider identifier issued to the organization String 0..n Issued by NPPES Organization Specialty Specialty of Organization String 0..n By selected item in code set

Organization Email Emails for the organization (other than Direct) String 0..n Query may include any of the Email Object data elements. Organization Electronic Service

Information Object See Electronic Service Information Object Object 0..n

Query may include any of the Electronic Service Information Object elements.

Organizational Digital Certificate ID As defined in the Response Data Set String 0..n This is a query field for a unique Digital Certificate serial number Organizational Digital Certificate

distinguished name As defined in the Response Data Set String 0..n This is a query field for a unique Digital Certificate distinguished name

QUERY DATA SET

Note: See Query and Response Examples for response requirements based on various combination of query elements Note: If query includes an object (e.g. address object) it must include one or more of the data elements defined in that data object

Individual

Organization

Worksheet: Query Data Set

(9)

Provider Directory ID As defined in the Response Data Set String 0,1 If present, it is the unique ID assigned to a specific Provider Directory that is the target of the query

Provider Directory Name As defined in the Response Data Set String 0,1 Name of Provider Directory to query

Telephone As defined in the Telephone Number Object String 0..n Query may include any of the Telephone Number Object data elements.

Individual-Organization Email

Email addresses (other than Direct) used by the individual referenced by Individual ID when associated with the organization referenced by Organization ID

String 0..n Query may include any of the Email Object data elements.

Organization Electronic Service

Information Object See Electronic Service Information Object Object 0..n

Query may include any of the Electronic Service Information Object elements.

Individual – Organization Relationship

Provider Directory

Worksheet: Query Data Set

(10)

Item Assumption

1 The transport protocol for Query for Electronic Service Information will provide appropriate

identification of the querying individual/organization. All

ASSUMPTIONS

Worksheet: Assumptions

(11)

Value Version Form of the Address String Content specification Further refining comments Location of specification Options Option specification

DirectProjectSMTP email address any

http://wiki.directproject.org/Applic ability+Statement+for+Secure+H ealth+Transport

CAQH CORE Connectivity

Rule V2.2.0

URLof

WSDL(caqh.org/SOAP/WSDL/CORERu le2.2.0.wsdl

any https + SOAP 1.2 and https

MIME Multipart

http://www.caqh.org/COREv5010 .php

MLLP HL7 V2.5 V2.5 IP address & port Lab Result - ELINCS, S&ILRIORURO1, ...

CIRImmunizationHL72.3.1 V3.0 URL of WSDL not allowed

CIR HL7 Web Service Integration Guide for Immunization Transactions using HL7 version 2.3.1

http://www.nyc.gov/html/doh/dow nloads/pdf/cir/cir-hl7.web-service-integration-guide.pdf

XDR:DocumentRecipient:Pro

vide&Register URL of WSDL any FT

http://www.ihe.net/Technical_Fra mework/index.cfm#IT : Vol. 2b Section 3.41

XDS:DocumentRegistry:Prov

ide&Register URL of WSDL any FT

XDS:DocumentRegistry:Regi

stryStoredQuery URL of WSDL not allowed FT

http://www.ihe.net/Technical_Fra mework/index.cfm#IT : Vol. 2a Section 3.18

XDS:DocumentRegistry:Retr

ieveDocSet URL of WSDL not allowed FT

PDQ:DemographicSupplier:

PatientDemographicQuery IP address & port not allowed FT

PIX:PatientIdentitySource:Pa

tientIdentifyFeed IP address & port not allowed FT

PIX:Manager:Query IP address & port not allowed FT

PDQV3:DemographicSupplie

r:PatientDemographicQuery URL of WSDL not allowed FT

http://www.ihe.net/Technical_Fra mework/index.cfm#IT : Vol. 2b Section 3.37 Pediatric Demographic PIXV3:PatientIdentifySource:

PatientIdentifyFeed URL of WSDL not allowed FT

Continuation

PIXV3:Manager:Query URL of WSDL not allowed FT

http://www.ihe.net/Technical_Fra mework/index.cfm#IT : Vol. 2b Section 3.45 Pediatric Demographic XDM:PortableMediaImporter:

SMTP email address any FT

Continuation

XCA:RespondingGateway:Cr

ossGatewayQuery URL of WSDL not allowed FT

XCA:RespondingGateway:Cr

ossGatewayRetrieve URL of WSDL not allowed FT

This worksheet contains representative examples of IntegrationProfiles and is not part of the data model, except as a reference.

INTEGRATION PROFILE EXAMPLES

Worksheet: IntegrationProfile Examples

(12)

XCPD:RespondingGateway:

PatientDiscovery URL of WSDL not allowed TI

http://www.ihe.net/Technical_Fra mework/index.cfm#IT : XCPD Supplement HPD:ProviderInformationDir ectory:ProviderInformationQ uery

URL of WSDL not allowed TI

http://www.ihe.net/Technical_Fra mework/index.cfm#IT : HPD Supplement

Worksheet: IntegrationProfile Examples

(13)

Value Version Content Type Content Form Content Standard Location of specification Constraint Option Specification

Lab Result - ELINCS V1.2 Ambulatory Lab Result Structured ELINCS HL7-R1 www.hl7.org

S&ILRIORURO1 V1.0 Lab Result - S&I LRI IG Structured S&I LRI HL7 ORU^R01 http://wiki.siframework.org/file/view/V251_IG _SIF_LABRESULTS_R1_N1_2011SEP.pdf

GU ISO OIDs

NG Non Global Identifiers RU Placer / Filler Order

Number

RN Universal Service

Identifier

HITSP C32 V2.5 Care Summary Structured HITSP C32 www.hitsp.org/ConstructSet_Details.aspx?& PrefixAlpha=4&PrefixNumeric=32

EHIWG CCD V1.0 Care Summary Structured EHR-HIE Interoperability

Workgroup CCD tbd

PDF Any content Structured or

Unstructured

http://www.iso.org/iso/catalogue_detail?csn umber=38920

DICOM V3.5 Image Report Structured DICOM PS 3.12 medical.nema.org

X12N 270/271

'005010 X279, X279A1

Eligibility Request and

Response Structured

Health Care Eligibility Benefit

Inquiry and Response www.x12.org

CAQH CORE Phase I

Operating Rules V1.1.0

Response Structured

CAQH CORE Phase I Operating Rules for X12N 005010X279, X279A1 Eligibility

http://www.caqh.org/COREv5010.php

CAQH CORE Phase II

Operating Rules V2.x.x

Response & Claim Status Structured

CAQH CORE Phase II Operating Rules for X12N 005010X212 Claim Status, 005010X279, X279A1 Eligibility

http://www.caqh.org/COREv5010.php

This worksheet contains representative examples of ContentProfiles and is not part of the data model, except as a reference.

CONTENT PROFILE EXAMPLES

Worksheet: ContentProfile Examples

(14)

Value Version Specification Location of specification Constraints Option specification

SAML 2.0 Security Markup Langugage 2.0 http://oasis-open.org

Basic Basic Attribute Profile

X.500/LDAP X.500/LDAP Attribute Profile

Trust:<name> This defines one of several possible X.509 certificate trust anchors, a set of possible trust anchors is below at row 15

NwHIN 3.0 The NwHIN authorization framework

http://healthit.hhs.gov/portal/server.p t/gateway/PTARGS_0_12811_9552 83_0_0_18/NHIN_AuthorizationFra meworkProductionSpecification_v3. 0.pdf

S/MIME 3.1 Secure/Multipurpose Internet Email Exentsions http://www.ietf.org/rfc/rfc3851.txt

Trust:<name> This defines one of several possible X.509 certificate trust anchors, a set of possible trust anchors is below at row 15

WS-Security 1.1 UserName Token

http://docs.oasis-open.org/standards#wssv1.1

Examples of Trust:<name>

Trust: Federal Bridge http://csrc.nist.gov/archive/pki-twg/y2002/papers/twg-02-03.pdf Trust: Safe Biopharma

This worksheet contains representative examples of SecurityProfiles and is not part of the data model, except as a reference.

SECURITY PROFILE EXAMPLES

Worksheet: SecurityProfile Examples