This wiki has undergone a migration to Confluence found Here

Provider Registry Implementation Guide

From HL7 Argonaut Project Wiki
Jump to navigation Jump to search

THIS PAGE IS FOR HISTORICAL REFERENCE ONLY

THIS PAGE IS FOR HISTORICAL REFERENCE ONLY

....

Description

Overview of how security, content model and behavioral rules fit together

Note that this profile uses extensions for several properties. These extensions are being evaluated for inclusion into the core resource in a future version.

note that there's a general model

  • provider - Practitioner resource, containing:
    • Personal details (name, identifiers)
    • Contact details (personal contacts, not usually used)
  • One more organizations at which the provider works (healthcare service). For each org
    • speciality
    • location
    • address
    • contact details
  • One more services for each organization at which the provider works (healthcare service). For each service
    • service
    • location
    • address
    • contact details

Security

Notes:

  • All implementers authorised via Smart on FHIR
  • scope: User/Practitioner.read & User/Organization.read

General Constraints

Telecom / Contact Points

  • appear in multiple places throughout the content
  • types: email, fax, home phone, mobile phone, work phone, page
  • all types are must-support, optional, 0..*
  • use the direct extension on email address to indicate an email address has Direct Support
  • value is required. rank is optional. period is prohibited

Address

  • appear in multiple places throughout the content
  • lines 1 /2, city, state, postcode
  • no district. Country prohibited and defaulted to USA
  • no text. use & type fixed to 'work' & 'physical'

Content model

Must Support means the providers must provide the data where their underlying data source has a value for the element

Notes:

  • only active records exposed
  • each entry has one (and only one) practitionerRole entry, which has one managing organization

Name

  • first name, middle name, last name
  • middle name optional, others required

Identifiers

  • identifiers for DEA Number, Medicaid + Medicare Numbers, NPI, and SSN (all must-support)
  • all identifiers have system+value + optional period
  • other elements prohibited
  • additional identifiers allowed, but no need for supporting other identifiers

Telecom / Contact Points

  • not expected to be used. If they are used, used for personal contact details. if they are, standard rules above apply

Address

  • not expected to be used. If they are used, used for personal address. if they are, standard rules above apply

PractitionerRole

  • have one role for each organization the provider as associated with
  • each role has Organization, speciality, location, healthcare service, and also extensions for Address and Contact Points. Other elements are not used.

PractitionerRole.Organization

  • mandatory
  • must have a reference that resolves to an Organization Resource if requested
  • must include the common name of the organization in the display to save retrieving the organization resource

PractitionerRole.Speciality

  • optional, repeating (more than one allowed)
  • must have a text
  • may have one or more codes, code system not fixed

PractitionerRole.location

  • optional - a reference to a Location resource
  • if present, must have a reference that resolves to an Organization Resource if requested
  • if present, must include the common name of the location in the display to save retrieving the location resource

PractitionerRole.address

PractitionerRole.contact

  • this is an extension, url = http://hl7.org/fhir/StructureDefinition/argonaut-provider-contact
  • optional, repeating
  • Contact details for the provider at this organization - if there's a general one. There's allowance for more specific address contact details below.
  • value is an address that follows the rules for address as above

PractitionerRole.healthcareService

  • optional, may repeat
  • a list if services that the practitioner provides for the organisation
  • if present, must have a reference that resolves to a HealthcareService Resource if requested
  • if present, must include a text description of the service in the display to save retrieving the healthcare service resource

PractitionerRole.healthcareService.location

  • this is an extension, url = http://hl7.org/fhir/StructureDefinition/argonaut-provider-location
  • optional - a reference to a Location resource the describes where the service is provided
  • value is a Reference(Location)
  • if present, must have a reference that resolves to an Organization Resource if requested
  • if present, must include the common name of the location in the display to save retrieving the location resource

PractitionerRole.healthcareService.address

PractitionerRole.healthcareService.contact

For a formal profile, see the [FHIR Current Build]

Behavioral Rules

  • todo
  • must search by: ??

Example

NPI Stock example

<Practitioner xmlns="http://hl7.org/fhir">
 
 <identifier>
   <system value="http://hl7.org/fhir/sid/us-npi"/>
   <value value="1497860456"/>
 </identifier>
 <name>
   <family value="HALAMKA"/>
   <given value="JOHN"/>
   <given value="D"/>
   <suffix value="MD"/>
 </name>
 <telecom>
   <system value="phone"/>
   <value value="617-754-8002"/>
 </telecom>
 <address>
   <line value="11 UNITY LN"/>
   <city value="SHERBORN"/>
   <state value="MA"/>
   <postalCode value="01770-1547"/>
 </address>
 <gender value="male"/>
 
 <practitionerRole>
   <extension url="http://hl7.org/fhir/StructureDefinition/argonaut-provider-address">
     <valueAddress>
       <line value="1135 TREMONT ST"/>
       <city value="ROXBURY CROSSING"/>
       <state value="MA"/>
       <postalCode value="02120-2140"/>
     </valueAddress>
   </extension>
   <extension url="http://hl7.org/fhir/StructureDefinition/argonaut-provider-contact">
     <valueContactPoint>
       <system value="phone"/>
       <value value="617-754-8002"/>
     </valueContactPoint>
   </extension>
   <extension url="http://hl7.org/fhir/StructureDefinition/argonaut-provider-contact">
     <valueContactPoint>
       <extension url="http://hl7.org/fhir/StructureDefinition/us-core-direct">
         <valueBoolean value="true"/>
       </extension>
       <system value="email"/>
       <value value="J.HALAMKA@direct.somehist.com"/>
     </valueContactPoint>
   </extension>
   <managingOrganization>
     <reference value="Organization/bidmc-lab"/>
     <display value="BIDMC Medical Laboratory"/>
   </managingOrganization>
   <specialty>
     <coding>
       <system value="https://npidb.org/taxonomy"/>
       
       <display value="Emergency Medicine"/>
     </coding>
   </specialty>
 </practitionerRole>
</Practitioner>


Related Requirements Documentation

  • Eric's Doco: [[1]]
  • Alan's doco: [[2]] (particularly [[3]])
  • NPI.io: [[4]]