statewide health consumer fhir apis · 2018-07-13 · this api supports the united states realm...

48
For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services Michigan Statewide Health Provider and Consumer Directory FHIR APIs 050516

Upload: others

Post on 01-Aug-2020

1 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

Michigan Statewide Health Provider and Consumer Directory FHIR APIs 

05‐05‐16

Page 2: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

2

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

VersionControl

Version Date Changes Author

0.0 11/04/15 Initialdraftversion JeffEastman

1.0 11/05/15 AddedlanguageandreferencestoFHIRstandardforimprovedcompatibilityandinteroperability

JeffEastman

2.0 11/10/15 Minoredits,movetoMiHINformat D.Livesay

3.0 11/10/15 AddedidfieldstorelevantobjectsanddefinedHPDIdentifierSystems

JeffEastman

4.0 11/10/15 RenamedtoFHIRAPIandaddedpractitionerRolefieldonPractitionertoencodespecialtyinformation.

JeffEastman

5.0 11/25/15 AddedFHIRPatientresourcetosupporttransactionalACRSadministration

AddedElectronicServiceandMembershipextensionstotheFHIRResourcedefinitions.

JeffEastman

6.0 01/07/16 UpdatedCodingsystemvaluestocorrespondwithURLformats

AddedasectionforDatatypestodistinguishthemfromResources

AddedStatewideConsumerDirectoryAPIsneededtopreservebackwardcompatibilitywhileutilizingFHIRresourcesanddatatypeswhereverpossible.

RemovedFHIRPatientresourcein

JeffEastman

Page 3: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

3

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

favorofFHIRPersonresourceandActiveCareRelationshipresourceextension

7.0 12/07/15 ReverseddecisiontoswitchfromPersontoPatientresourcesinordertoeliminatetheneedforPersonalRelationshipsintheSCDAPIdefinition.Patient.ContactfieldsalreadycontainmostofthisfunctionalityandtherestcanbeexpressedwithExtensions.

JeffEastman

8.0 12/22/15 AdjustedFHIRextensiontypestobecompatibleBasicresourcetypesandaddedexamplesfromoperationalHAPI‐FHIRserverincorporatingthem.

JeffEastman

9.0 01/07/16 RemovedmemberandactiveCareRelationshipextensionstoOrganizationsbecausetheydon’tscalewellinpractice.

AddedadministratorfieldtoActiveCareRelationshipstosupportlinkingtosubmittingorganization

RemovedcareProviderandmanagingOrganizationfromSCDPatienttoeliminatePHIfromthisrecordtype.

AddedFHIRContracttorecordConsentDirectivesintheSCD

JeffEastman

10.0 01/25/16 RemovedpractitionerRoleforencodingNUCCTaxonomyspecialtyinformation

JeffEastman

Page 4: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

4

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

AddedtaxonomyextensionstoOrganizationandPractitionertoencodeNUCCTaxonomyspecialtyinformation

AddedqualificationextensiontoOrganizationtoencodecredentialinformationforlicenses&othercredentials

11.0 02/09/16 Minorfieldrenamingandcorrectionstoalignwithslidepresentation

JeffEastman

12.0 03/03/16 AddedattributionfieldtoActiveCareRelationship

AdjustedthedefinitionofCodeableConcepttorequireasingleCoding

JeffEastman

13.0 03/14/16 RemovedthebackwardscompatibilityAPIsections

JeffEastman

14.0 05/05/16 ReferencedFHIRHL7v2codings.

AddedfieldstoServiceDescription

JeffEastman

Page 5: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

5

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

TableofContentsIntroduction.................................................................................................................................................8

FHIRResources...........................................................................................................................................8

Organization............................................................................................................................................9

Practitioner..............................................................................................................................................9

Bundle.....................................................................................................................................................10

FHIRResourceExtensions..................................................................................................................11

Organization.........................................................................................................................................11

Practitioner...........................................................................................................................................11

Membership..........................................................................................................................................12

ElectronicService................................................................................................................................12

Datatypes....................................................................................................................................................13

Identifier................................................................................................................................................13

Address...................................................................................................................................................14

CodeableConcept................................................................................................................................14

Coding......................................................................................................................................................14

ContactPoint.........................................................................................................................................15

HumanName.........................................................................................................................................15

Period......................................................................................................................................................15

HPDSupportedCodings.......................................................................................................................16

OrganizationTypes...........................................................................................................................16

PractitionerTypes.............................................................................................................................16

OrganizationIdentifierTypes..........................................Error!Bookmarknotdefined.

PractitionerIdentifierTypes............................................Error!Bookmarknotdefined.

OrganizationMembershipTypes................................................................................................16

PractitionerMembershipTypes..................................................................................................17

ServiceDestinationTypes..............................................................................................................17

ContentProfileTypes.......................................................................................................................17

IntegrationProfileTypes................................................................................................................17

HPDIdentifierSystems.........................................................................................................................18

StatewideConsumerDirectoryFHIRAPI.....................................................................................19

Page 6: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

6

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

SCDResources..........................................................................................................................................19

Patient.....................................................................................................................................................19

Contract..................................................................................................................................................20

SCDResourceExtensions....................................................................................................................21

Organization.........................................................................................................................................21

Patient.....................................................................................................................................................21

Membership..........................................................................................................................................21

ServiceDescription.............................................................................................................................21

ActiveCareRelationship...................................................................................................................22

SCDSupportedCodings........................................................................................................................24

PatientIdentifierTypes......................................................Error!Bookmarknotdefined.

PatientMembershipTypes............................................................................................................24

ServiceDescriptionTypes..............................................................................................................24

ServiceDescriptionTypes..............................................................................................................24

RESTfulAPI................................................................................................................................................26

InstanceLevelInteractions............................................................................................................26

TypeLevelInteractions...................................................................................................................26

WholeSystemInteractions............................................................................................................26

Authentication..........................................................................................................................................27

RequestinganAccessToken.........................................................................................................27

Security...................................................................................................................................................27

Authorization............................................................................................................................................28

HPDProfiles..........................................................................................................................................28

SCDProfiles...........................................................................................................................................29

NISTLevelsofAssurance................................................................................................................29

IdentityProofing.................................................................................................................................30

Examples.....................................................................................................................................................31

AnExampleOrganization...............................................................................................................31

AnExampleOrganization“PeaceofMind”.............................................................................32

AnExamplePractitioner.................................................................................................................34

AnExamplePatient...........................................................................................................................38

Page 7: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

7

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

AnExampleElectronicService.....................................................................................................41

AnExampleMembership................................................................................................................43

AnExampleActiveCareRelationship.......................................................................................44

AnExampleContractforaConsentDirective........................................................................46

Page 8: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

8

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

Introduction

ThisdocumentdefinesaRESTfulAPIthatcanbeusedtoCreateandUpdateProvidersandOrganizationswithintheStatewideHealthProviderDirectory(HPD).ThisinterfaceadoptstheterminologyandsemanticsofasubsetoftheHL7FastHealthcareInteroperabilityResources(FHIR)standard.ReferencestoparticularresourcesdefinedbytheFHIRstandardandadoptedbythisAPIareincludedintheparagraphsbelow.

ThisdocumentalsodefinesaRESTfulAPIthatcanbeusedcreateandupdateinformationaboutConsumerswithintheStatewideConsumerDirectory(SCD).TheHPDandSCDresideinthesameSalesforceinstanceandmanyoftheresourcesareinterdependent(esp.ActiveCareRelationship),thusthesetwoAPIssharethesamedocument.

FHIRResources

“Resourcesrepresentgranularclinicalconcepts.Theresourcescanbemanagedinisolation,oraggregatedintocomplexdocuments.Thisflexibilityofferscoherentsolutionsforarangeofinteroperabilityproblems.Thesimpledirectdefinitionsoftheresourcesarebasedonthoroughgatheringofrequirements,formalanalysisandextensivecross‐mappingtootherrelevantstandards.

Eachresourcecarriesamasterid.Theidisneverchangedorreused,anditidentifiestheresourcepermanently.Resourcesmayrefertootherresourcesbyidknowingthatthisisastablereference.EachresourcehasaURLwhichisderivedfromtheid,thetype,andthelocalbaseURL.Givenoneresourceaddress,theaddressofanyotherresourcecanbeautomaticallydetermined.

Resourcescontainreferencestootherresources.Whileeachresourcecanbereadand/orchangedwithoutexplicitreferencetotheseotherresources,thepresenceofthesereferencesinfluencesthebehaviorofthesystem:implementationsarerequiredtomaintainsystemanddataintegrityatalltimes.

Eachresourcesupportsthesamelistoftransactions‐read,update,delete,etc.Oneparticularlyimportanttransactionsupportedbyeveryresourcetypeisthe

Page 9: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

9

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

provisionofaconformancestatementwhichspecifieswhatpartsofthedefinedcontentmodelaresupportedbythesystem,andwhatothertransactionsorinteractionsaresupported.Ifanyoftheotherinteractionsaresupported,theconformanceinteractionmustbesupported.(i.e.iftheconformanceinteractionreturnsanerror,nooperationsaresupported).”‐FromFHIRResources.

ThissectiondefinestheResourcessupportedbythisAPI,theirsupporteddatafieldsandhowthesefieldsaremappedtotheinternalHPDdatamodel.

Organization

“Aformallyorinformallyrecognizedgroupingofpeopleororganizationsformedforthepurposeofachievingsomeformofcollectiveaction.Includescompanies,institutions,corporations,departments,communitygroups,healthcarepracticegroups,etc.”‐fromFHIROrganization.ThefollowingfieldsaresupportedbythisAPI:

id–[0..1]InheritedfromResource.TheOrganization.ID name–[1..*]OrganizationNamerelatedobjects type–[0..1]Organization.Type identifier–[0..*]OrganizationIdentifierrelatedobjects address–[0..*]OrganizationAddressrelatedobjects telecom–[0..*]OrganizationTelephone,Email,Website

Practitioner

“Apersonwhoisdirectlyorindirectlyinvolvedintheprovisioningofhealthcare.”‐fromFHIRPractitioner.ThefollowingfieldsaresupportedbythisAPI:

id–[0..1]TheContactID(ProvidersarearecordtypeofContact) name–[1..*]ProviderNamerelatedobjects active–[0..1]Provider.Status gender–[0..1]Provider.Gender birthdate‐[0..1]Provider.Birthdate identifier–[0..*]ProviderIdentifierrelatedobjects telecom–[0..*]Provider.Telephone,Email address–[0..*]ProviderAddressrelatedobjects

Page 10: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

10

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

qualification–[0..*]ProviderCredentialrelatedobjects

Bundle

“Acontainerforacollectionofresources.”‐fromFHIRBundle.ThefollowingfieldsaresupportedbythisAPI:

type–[1..1] entry–[1..*]

Page 11: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

11

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

FHIRResourceExtensions

This API supports the following classes that augment and extend the current set of FHIR Resources. They closely model the current HPD artifacts and are required to support the current production HPD use cases. These new resources will be submitted to the FHIR development process in the hopes they can be incorporated into that standard at some point in the future.

Organization

The following new fields extend the standard definition of Organization as noted above. These fields are implemented using the FHIR Extensibility mechanism:

service – [0..*] References to ElectronicServices are encoded as Extensions with the MIHIN_ELECTRONIC_SERVICE_URL = http://org.mihin.fhir.extension.electronic-service

taxonomy–[0..*]OrganizationSpecialtyrelatedobjectsareencodedasExtensionswiththeNUCC_TAXONOMY_URL=http://org.nucc.taxonomy

qualification–[0..*]OrganizationCredentialrelatedobjectsareencodedasExtensionswiththeMININ_QUALIFICATION_URL=org.mihin.qualification

Practitioner

This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes. If a Direct email is encoded in a telecom associated with the Practitioner, this will have the effect of adding/updating an appropriate ElectronicService in the service below. The following new fields also extend the standard definition of Practitioner as noted above: These fields are implemented using the FHIR Extensibility mechanism:

service – [0..*] References to ElectronicServices are encoded as Extensions with the MIHIN_ELECTRONIC_SERVICE_URL = http://org.mihin.fhir.extension.electronic-service

taxonomy–[0..*]ProviderSpecialtyrelatedobjectsareencodedasExtensionswiththeNUCC_TAXONOMY_URL=http://org.nucc.taxonomy

Page 12: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

12

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

Membership

A Membership denotes a formal relationship between a Practitioner or Organization and another Organization in which the member participates or has participated. These fields are implemented using the FHIR Extensibility mechanism as instances of the FHIR Basic resource.

id–[0..1]InheritedfromResource.TheIDoftheMembership code–[1..1]ACodeableConceptthatincludesthe

MIHIN_ELECTRONIC_SERVICE_URL coding extensions–ThisBasicresourceisfurtherextendedwithextensions

havingtheMIHIN_ELECTRONIC_SERVICE_URL withthefieldnameappendedandseparatedbyaperiod. type – [1..1] A CodeableConcept that denotes the type of the

membership. See Organization Membership Types and Practitioner Membership Types below.

owner – [1..1] A Reference to an Organization that has the members

member – [1..1] A Reference to a Practitioner or Organization identifier–[0..1]AnIdentifierbywhichthememberisknown

totheorganization service – [0..*] References to Electronic Services period – [0..1] A Period that defines the effective dates of this

membership

ElectronicService

ElectronicServices represent the information required to securely transmit protected health information from one system to another system electronically. These fields are implemented using the FHIR Extensibility mechanism as instances of the FHIR Basic resource.

id –[0..1]InheritedfromResource.TheElectronic_Service__c.ID code–[1..1]ACodeableConceptthatincludesthe

MIHIN_ELECTRONIC_SERVICE_URLcoding extensions–ThisBasicresourceisfurtherextendedwithextensions

havingtheMIHIN_ELECTRONIC_SERVICE_URLwiththefieldnameappendedandseparatedbyaperiod. name – [1..1] A plain text string name of the service

Page 13: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

13

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

destination – [0..*] A list of CodeableConcepts that denote the MiHIN Shared Services for which this Electronic Service is a destination. See Service Destination Types below.

content – [1..*] A list of CodeableConcepts that denote the content data types consumed by this service (i.e. delivery preferences). See Content Profile Types below.

integration – [1..1] A CodeableConcept that denotes the networking protocol expected by this service. See Integration Profile Types below.

address – [1..1] A string denoting the service’s delivery address (Direct email, IP, logical address)

Datatypes“TheFHIRspecificationdefinesasetofdatatypesthatareusedfortheresourceelements.Therearetwocategoriesofdatatypes:simple/primitivetypes,whicharesingleelements,andcomplextypes,whicharere‐usableclustersofelements.”FromFHIRDatatypes.

Identifier

“Anumericoralphanumericstringthatisassociatedwithasingleobjectorentitywithinagivensystem.Typically,identifiersareusedtoconnectcontentinresourcestoexternalcontentavailableinotherframeworksorprotocols.Identifiersareassociatedwithobjects,andmaybechangedorretiredduetohumanorsystemprocessanderrors.”‐fromFHIRIdentifier.ThefollowingfieldsaresupportedbythisAPI:

id–[0..1]Requiredforupdate,optionalforread,notallowedforcreate

use–[1..1]usual|official|temp|secondary type–[0..1]SeeHPDSupportedCodings,below system–[1..1]The namespace for the identifier. See HPDIdentifier

Systems,below value–[1..1]Thevaluethatisunique period–[0..1]Thetimeperiodwhentheidentifieris/wasvalidfor

use

Page 14: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

14

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

Address

“Apostaladdress.Thereareavarietyofpostaladdressformatsdefinedaroundtheworld.Postaladdressesareoftenalsousedtorecordalocationthatcanbevisitedtofindapatientorperson.”‐fromFHIRAddress.ThisAPIalsosupportstheUnitedStatesRealmFHIRProfileextensionstoencodecountyinformationinaddresses.ThefollowingfieldsaresupportedbythisAPI:

id–[0..1]Requiredforupdate,optionalforread,notallowedforcreate

use–[1..1]Organization|Provider_Address__c.Use__c type–[1..1]Organization|Provider_Address__c.Type__c line–[1..1]Organization|Provider_Address__c.StreetAddress_1__c city–[1..1]Organization|Provider_Address__c.City__c district–[0..1]Organization|Provider_Address__c.County__c state–[1..1]Organization|Provider_Address__c.State__c postalCode–[1..1]Organization|Provider_Address__c.Postal_Code__c country–[0..1] period–[0..1]

CodeableConcept

“ACodeableConceptrepresentsavaluethatisusuallysuppliedbyprovidingareferencetooneormoreterminologiesorontologies,butmayalsobedefinedbytheprovisionoftext.Thisisacommonpatterninhealthcaredata.”‐fromFHIRCodeableConcept.ThisAPIrestrictsCodeableConceptstoarepresentationcontainingasingle,requiredCoding.ThefollowingfieldsaresupportedbythisAPI:

coding–[1..1]Codedefinedbyaterminologysystem text–[0..1]Plaintextrepresentationoftheconcept

Coding

‘ACodingisarepresentationofadefinedconceptusingasymbolfromadefined"codesystem"‐seeUsingCodesinResourcesformoredetails.’‐fromFHIRCoding.ThefollowingfieldsaresupportedbythisAPI:

Page 15: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

15

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

system–[1..1]Identityoftheterminologysystem code–[1..1]Symbolinsyntaxdefinedbythesystem display–[0..1]Representationdefinedbythesystem

ContactPoint

“Detailsforallkindsoftechnology‐mediatedcontactpointsforapersonororganization,includingtelephone,email,etc.”‐fromFHIRContactPoint.ThisAPIalsosupportstheUnitedStatesRealmFHIRProfileextensionstoencodethedirectflagindicatingthataparticularemailaddresscanbeusedwiththeDirectprotocol.ThefollowingfieldsaresupportedbythisAPI:

system‐required value‐required use‐required rank‐optional period‐optional

HumanName

“Anameofahumanwithtext,partsandusageinformation.”‐fromFHIRHumanName.ThefollowingfieldsaresupportedbythisAPI:

use–required prefix‐optional given‐required family‐required suffix‐optional

Period

“Atimeperioddefinedbyastartandenddate/time.”‐fromFHIRPeriod.ThefollowingfieldsaresupportedbythisAPI:

start–optional.IfnotpresentPeriodhasbeenongoing end–optional.IfnotpresentPeriodisongoing

Page 16: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

16

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

HPDSupportedCodings

ThefollowingCodingsrepresentthevocabularyusedforCodeableConceptsusedinthisAPI:

OrganizationTypes

These codings are used to denote the types of Organizations supported by this API.

system=“http://org.mihin.fhir.organization.type” code={ACO,Association,Clinic,Department,HIE,Hospital,Lab,Long

TermCareFacility,MedicalSchool,Payer,Pharmacy,PO,Practice,University,Other}

display=(typeifcode=Other)

PractitionerTypes

These codings are used to denote the types of Practitioners supported by this API.

system=“http://org.mihin.fhir.practitioner.type” code={CareCoordinator,CertifiedNurseMidwife,Chiropractor,

DoctorofOsteopathy,LicensedPracticalNurse,MedicalDoctor,MedicalTechnologist,Non‐clinicalStaff,Nurse,NursePractitioner,Optometrist,Pharmacist,PhysicalTherapist,PhysicianAssistant,Podiatrist,RegisteredNurse,Other}

display=(typeifcode=Other)

OrganizationMembershipTypes

These codings are used to denote the types of Organization Memberships supported by this API.

system=“http://org.mihin.fhir.organization.membership.type” code={PartOf,MemberOf,ServiceProviderTo,Other} display=(typeifcode=Other)

Page 17: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

17

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

PractitionerMembershipTypes

These codings are used to denote the types of Practitioner Memberships supported by this API.

system=“http://org.mihin.fhir.practitioner.membership.type” code={EmployedBy,MemberOf,PracticesIn,HasAdmitting

PrivilegesIn,AcceptsBenefitPlanOf,Other} display=(typeifcode=Other)

ServiceDestinationTypes

These codings are used to denote the types of Service Destinations supported by this API.

system=“http://org.mihin.fhir.service.destination.type” code={Immunizations,LaboratoryResults,QualityMeasures,

TransitionsofCare,MedicationReconciliation,Other} display=(typeifcode=Other)

ContentProfileTypes

These codings are used to denote the types of Content Profiles supported by this API: HL-7 ADT message types and LOINC codes. See Known Code Systems for additional details

system = http://hl7.org/fhir/ValueSet/v2-0354 code = see http://hl7-fhir.github.io/v2/0354/index.html system = http://loinc.org code =

34133-9

IntegrationProfileTypes

These codings are used to denote the types of Integration Profiles supported by this API.

system=“http://org.mihin.fhir.integration.profile.type” code={DirectSMTP,LLP,Other} display=(typeifcode=Other)

Page 18: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

18

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

HPDIdentifierSystemsThisisalistoftheIdentifiersystemsthathavebeendefinedforthisAPI:

NPI‐http://hl7.org/fhir/sid/us‐npi‐AssignedbytheNationalPlanandProviderEnumerationService

SSN‐http://hl7.org/fhir/sid/us‐ssn‐AssignedbytheUSSocialSecurityadministration

SSN‐4‐http://mihin.org/fhir/sid/us‐ssn‐4‐Thelast4digitsofaSSN Medicare‐http://mihin.org/fhir/sid/medicare–AssignedbyUS

Medicare Medicaid‐http://mihin.org/fhir/sid/Medicaid–AssignedbyUS

Medicaid OID–http://hl7.org/fhir/sid/oid‐AssignedbyHL7 HSTROID–http://mihin.org/fhir/sid/oid‐DefinedbyMichigan

MDHHS StarLIMS‐http://mihin.org/fhir/sid/starlims–Assignedby

MichiganMDHHS BloodSpot‐http://mihin.org/fhir/sid/bloodspot‐Assignedby

MichiganMDHHS CommonKeyService‐http://mihin.org/fhir/sid/cks–Assignedby

MiHINcommonkeyservice

Page 19: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

19

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

StatewideConsumerDirectoryFHIRAPIThefollowingAPIissupportedinordertosupportthecurrentSCDfunctionality.

SCDResourcesThefollowingFHIRResourcesaresupportedbytheSCDFHIRAPI:

Patient

“Demographicsandotheradministrativeinformationaboutanindividualoranimalreceivingcareorotherhealth‐relatedservices.”‐fromFHIR Patient.ThefollowingfieldsaresupportedbythisAPI:

id–[0..1]ThePatientIDfield(PatientsarerecordtypesofContact)name–[1..*]PatientName&PatientNamerelatedobjects

active–[0..1]PatientStatus identifier–[0..*]PatientIdentifierrelatedobjects telecom–[0..*]PatientTelephone,fax,email,… address–[0..*]PatientAddressrelatedobjects gender–[0..1]PatientGender birthdate–[0..1]PatientBirthdate contact–[0..*]PatientRelationshiprelatedobject

Thereare3mainmethodsthataPatientcanbeidentifiedinthisAPI: Byid.ThisisthemostefficientwaytouniquelyidentifyaPatientin

thedirectory,asSalesforceindexesallObjectsbythisvalue. Byidentifier.Thisisthesecondmostefficientwaytoidentifya

Patientinthedirectory.AsearchwillbedoneonthePatient_Identifier__crelatedobjects,indexedbysystemandvalue.

Bydemographicmatching.ThesuppliedfieldswillbepassedtotheMiHINCommonKeyServicetoretrieveacommonkeyIdentifierforthePatient.IfsuchanIdentifierisreturned,asearchwillbedoneusingthisvalue.

Note:Intheeventthatmorethanoneofthesemethodsisprovidedinasingleserviceendpointrequest,onlyonewillbeevaluatedintheorderofid,identifier,anddemographics.

Page 20: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

20

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

Note:Intheeventthatmorethanoneidentifierissupplied,allidentifierswillbeusedtoquerytheSCDandallmustuniquelyidentifythesamePatientinthedirectory.Otherwiseanerrorwillbereturned.Note:TheMiHINCommonKeyServicecurrentlyrequiresvaluesforthefollowingfieldsinordertobeabletoreturnacommonkeyIdentifier:name,gender,birthDate,andoneaddress.

Contract

“Aformalagreementbetweenpartiesregardingtheconductofbusiness,exchangeofinformationorothermatters.”FromFHIRContract.ContractsareuseintheSCDtorecordConsentDirectivesasintheFHIRConsentDirectiveProfile.ThefollowingfieldsaresupportedinthisAPI:

id–[0..1]inheritedfromResource identifier–[0..1]anIdentifierforthecontract issued–[1..1]theDateTimethecontractwasissued applies–[0..1]thePeriodduringwhichthiscontractapplies subject–[1..1]aReferencetothePatientwhoseinformationisbeing

shared type–[1..*]aCodeableConceptthatdescribesthetype(s)of

informationtobeshared subtype–[0..*]aCodeableConceptthatdescribesthesubtype(s)of

information agent–[1..*]oneormoreActorComponentsthatidentifytheactors

(senders&recipients)inthesharingofinformation. signer–[1..*]oneormoreSignatureComponentsthatidentifythe

person(s)executingtheContract legal–[1..1]aReferencetotheactuallegaldocumentthatwas

executed.ThiswilltypicallybetheexternalURLofthatdocumentasstoredinanexternaleCMSsystembutitmayalsobeaninternalreferenceifthedocumentishostedintheSCD.

service–[0..1](FHIRExtension)aReferencetotheElectronicServiceofthehostingeCMSprovider

Note:TheMichiganeCMSdefinitionsarestillfluid,thusthispartoftheSCDAPImaybeexpectedtochangeaswetracktheMichiganstandardsinthisarea.Also,theCodingstobeusedforMichiganConsentDirectivesneedtobedefined.Theexampleshownbelowhasillustrativevaluesonly.

Page 21: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

21

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

SCDResourceExtensions

This API supports the following classes that augment and extend the current set of FHIR Resources. They closely model the current SCD artifacts and are required to support the current production SCD use cases. These new resources will be submitted to the FHIR development process in the hopes they can be incorporated into that standard at some point in the future.

Organization

The following new fields extend the standard definition of Organization as noted above:

serviceDescription – [0..*] References to ServiceDescriptions are encoded as Extensions with the MIHIN_SERVICE_DESCRIPTION_URL = http://org.mihin.fhir.extension.service-description

Patient

This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes.

Membership

TheHPDResourceExtensionMembershipisfurtherextendedtoallowthefollowingadditionalfieldvalues:

type–(1..1)ThetypemayalsobeselectedfromthePatientMembershipTypecodings,definedbelow.

member(1..1)ThemembermayalsobeaReferencetoaPatient

ServiceDescription

A ServiceDescription wraps an ElectronicService and its hosting Organization into an object that contains adequate information for an end user to select a particular Membership in which to participate as a member. These fields are implemented using the FHIR Extensibility mechanism as instances of the FHIR Basic resource.

id –[0..1]InheritedfromResource.TheService_Description__c.ID. code–[1..1]ACodeableConceptthatincludesthe

MIHIN_SERVICE_DESCRIPTION_URL coding

Page 22: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

22

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

extensions–ThisBasicresourceisfurtherextendedwithextensionshavingtheMIHIN_SERVICE_DESCRIPTION_URL withthefieldnameappendedandseparatedbyaperiod. type – [1..1] A CodeableConcept that identifies the type of the

Membership to be created to subscribe to this service. See Service Description Types below.

name – [1..1] A string that denotes the name of the service icon - [0..1] An image that can be used to represent the service description – [0..1] A string that provides a longer description of

the service. criteria – [0..1] A string that describes the enrollment eligibility

criteria that a potential user must meet to qualify as a member of the service.

enrollment - [0..1] A URL that points to a web site offered by the organization where potential users could express interest in or enroll in the service.

organization – [1..1] A Reference to the Organization that is offering the service

service - [1..1] A Reference to an ElectronicService that supports this ServiceDescription

ActiveCareRelationship

ActiveCareRelationshipsareusedtorecordthemembersofaPatient’sCareTeam,asreportedtotheMiHINActiveCareRelationshipService(ACRS)byQualifiedOrganizations(QO).ThesefieldsareimplementedusingtheFHIRExtensibilitymechanismasinstancesoftheFHIRBasicresource.

id–[0..1)InheritedfromResource.TheActive_Care_Relationship__c.ID

code–[1..1]ACodeableConceptthatincludestheMIHIN_ACTIVE_CARE_RELATIONSHIP_URL coding

extensions–ThisBasicresourceisfurtherextendedwithextensionshavingtheMIHIN_ACTIVE_CARE_RELATIONSHIP_URL withthefieldnameappendedandseparatedbyaperiod. patient–[1..1)AReferencetothe

Active_Care_Relationship__c.Patient provider–[1..1)AReferencetothe

Active_Care_Relationship__c.Provider practice–[1..1)AReferencetothe

Active_Care_Relationship__c.Practice

Page 23: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

23

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

manager–[1..1)AReferencetotheActive_Care_Relationship__c.Manager

attribution–[0..*]ZeroormoreCodeableConceptsdenotingtheattributionmechanism(s)employedtoproducethisrelationship

period–[0..1]Theperiodoftimeduringwhichthisactivecarerelationshipexists

Page 24: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

24

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

SCDSupportedCodings

ThefollowingCodingsrepresentthevocabularyusedforCodeableConceptsusedinthisAPI:

PatientMembershipTypes

These codings are used to denote the types of Patient Memberships supported by this API.

system=“http://org.mihin.fhir.patient.membership.type” code={PreferredPortal,PreferredPHR,AdvanceDirectiveLocation,

Other} display=(typeifcode=Other)

ServiceDescriptionTypes

These codings are used to denote the types of Service Destinations supported by this API.

system=“http://org.mihin.fhir.service.description.type” code={AdvanceDirective,Other} display=(typeifcode=Other)

ServiceDescriptionTypes

These codings are used to denote the types of Active Care Relationship attributions supported by this API.

system=http://org.mihin.fhir.active-care-relationship.attribution.type code=seeCodesintablebelow display=seeDisplayintablebelow

Code Display DescriptionDP Declaredbypatient Declared:StatedastruebypatientDC Declaredbycaregiver Declared:StatedastruebyacaregiverRP Reportedbyprovider Reported:ByProviderinaclaimor

medicaltransactionaboutagivenpatientorbeneficiary

Page 25: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

25

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

RO Reportedbyorganization Reported:ByOrganizationinaclaimormedicaltransactionaboutagivenpatientorbeneficiary

AL Algorithmicallyassigned Assigned:Linkmadebyanalgorithmormodel

CP Confirmedbypatient Confirmed:BypatientCC Confirmedbycaregiver Confirmed:BycaregiverXP Contestedbypatient Contested:BypatientXG Contestedbycaregiver Contested:Bycaregiver

Page 26: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

26

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

RESTfulAPI

‘Each"resourcetype"hasthesamesetofinteractionsdefinedthatcanbeusedtomanagetheresourcesinahighlygranularfashion.Applicationsclaimingconformancetothisframeworkclaimtobeconformantto"RESTfulFHIR"(seeConformance).

NotethatinthisRESTfulframework,transactionsareperformeddirectlyontheserverresourceusinganHTTPrequest/response.SeethesectiosnbelowformoreinformationonAuthenticationandAuthorization.

TheAPIdescribestheFHIRresourcesasasetofoperations(knownas"interactions")onresourceswhereindividualresourceinstancesaremanagedincollectionsbytheirtype.Serverscanchoosewhichoftheseinteractionsaremadeavailableandwhichresourcetypestheysupport.ServersSHALLprovideaconformancestatementthatspecifieswhichinteractionsandresourcesaresupported.’‐textfromFHIRRestfulAPI.

InstanceLevelInteractions

ThefollowinginstanceinteractionsaresupportedbythisAPI:

read–anHTTPGET update–anHTTPPUT delete–anHTTPDELETE.Notethatobjectsarenotactuallydeleted

bythisoperationandcanbeun‐deletedbysystemadministrators

TypeLevelInteractions

ThefollowingtypelevelinteractionsaresupportedbythisAPI:

create–anHTTPPOST search–anHTTPGETorPOST

WholeSystemInteractions

ThefollowingwholesysteminteractionsaresupportedbythisAPI:

Page 27: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

27

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

conformance–AnHTTPOPTIONSorGET

Authentication

SeetheForce.comRESTDevelopersGuidefordetailsonaccessingthisAPI(http://www.salesforce.com/us/developer/docs/api_rest/api_rest.pdf).Therequiredlogincredentials,ConnectedApplicationConsumerKeyandConsumerSecretmaybeobtainedfromMiHIN.

TofindtheendpointneededtomakeAPIcalls,authenticationmustbedoneusingOAuthaspertheWebServiceAuthorizationwithOAuthdocumentation.Theresponsewillincludean“instance_url”parameter.Usethevalueofthisparameterinplaceof“{instance_url}”whendeterminingtheendpointforanAPIquerybasedontheURLsection.

RequestinganAccessToken

End‐userusernameandpasswordcredentialsmustbeprovidedinordertorequestanaccesstoken,whichcanbeusedasasessionID.Thisaccesstokencanbeusedtoperformadditionaloperationsonthedirectory.Theusershouldmakeanout‐of‐bandPOSTrequesttothetokenendpoint,withthefollowingparameters:

● grant_type - Value must be password for this flow. ● client_id - Consumer key from the connected app definition. ● client_secret - Consumer secret from the connected app definition. ● username - End-user username. ● password - End-user password

Note:password=SFPassword+SFSecurityToken

Security

Allcommunicationistobedoneoverport443.ThefollowinglistofSalesforceserversmayrequirewhitelisting:

● 96.43.144.0/20 _ subnet mask: 255.255.240.0 ● 136.146.0.0/15 _ subnet mask: 255.254.0.0 ● 182.50.76.0/22 _ subnet mask: 255.255.252.0 ● 204.14.232.0/21 _ subnet mask: 255.255.248.0

Page 28: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

28

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

AuthorizationAuthorizationinSalesforceisaccomplishedbyassociatingaProfilewitheachUserAccount.EachprofiledeterminesthefieldsandobjectsthatcanbeviewedorupdatedwithintheSalesforceinstance.WithintheHPDandSCD,differentrecordtypesofSalesforceContactobjectsareusedtorepresentthePractitionersandPatients(ProvidersandConsumers)describedinthisAPI.Inorderforanexternalusertoaccessanyoftheinformationinthesedirectories,theymusthaveaUserAccountwithaProfilethatdefinestheirauthorizedlevelsofaccesstotheinformationinthedirectory.

HPDProfiles

AlloftheinformationintheHPDisvisible(readonly)toallusersofbothdirectories.WedistinguishsixlevelsofwriteauthorizationbydefiningthefollowingProfiles:

HPDProvider–HPDProviderscancreateandupdateinformationaboutthemselveswithintheHPDusingwebportalaccessonly.NoAPIaccessissupportedforthisprofile.

HPDOrganizationAdministrator–HPDOrganizationAdministratorscancreateandupdateinformationabouttheorganizationsandpractitionersintheirpopulationusingwebportalaccessonly.NoAPIaccessissupportedforthisprofile.Populationsmaybeflexiblydefinedtosuitavarietyofaccessingneedsandsystemadministratorsperformthisconfiguration.

HPDPopulationAdministrator–HPDPopulationAdministratorshavethesamecreateandupdatepermissionsasOrganizationAdministrators,butcanalsocreateUserAccountsfortheirprovidersandorganizationadministrators.Populationadministratorshaveadditionalpermissionstocreatereports,modifytheirportalbrandingandtheyhavefullAPIaccesstothemembersoftheirpopulation.

HPDPlatformRead–HPDPlatformReadusershavelimitedwebaccesstotheHPDbuthavefull,read‐onlyaccesstothedirectoryusingtheHPDAPIdefinedabove.

HPDPlatformWrite–HPDPlatformWriteusershavelimitedwebaccesstotheHPDbuthavefull,read‐writeaccesstothedirectoryusingtheHPDAPIdefinedabove.

SystemAdministrators–SystemAdministratorshavefullaccesstoalloftheinformationinbothdirectoriesandaretheonlyHPDprofilesthatallowdeletionofinformationinthedirectory.

Page 29: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

29

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

SCDProfiles

TheinformationintheSCDisconsideredtobeHIPAAProtectedHealthInformation(PHI)andsoaccesstothisinformationismuchmorecloselycontrolled.Wecurrentlydefineonlythreeprofilesthatcanbeusedtoaccessthisinformation:

SCDPlatformRead‐SCDPlatformReadusershavelimited,read‐onlyaccesstoasubsetoftheSCDinformationthatisnecessarytoroutehealthinformationtodestinationsspecifiedbyconsumers(PatientsintheAPI)inthedirectory.SeeConsumerAffiliationsbelowformoredetails.

SCDPlatformWrite–SCDPlatformWriteusershavefullread‐writeaccesstotheinformationaboutthemselvesandconcerningotherconsumers(PatientsintheAPI)whohavespecifiedthemascaretakers.SeethesectiononConsumerRelationshipsbelowfordetailsonhowthisisspecified.

SystemAdministrators‐SystemAdministratorshavefullaccesstoalloftheinformationinbothdirectoriesandaretheonlySCDprofilesthatallowdeletionofinformationinthedirectory

NISTLevelsofAssurance

TheNationalInstituteofStandardsandTechnology(NIST)definesfourlevelsofassurancethatareadoptedbythisAPIdefinition.Asummaryoftheserequirementsisprovidedbelow.PleaseseeNISTSP800‐63‐2forthefulldetails.

1. Level1- Although there is no identity proofing requirement at this level, the authentication mechanism provides some assurance that the same Claimant who participated in previous transactions is accessing the protected transaction or data. It allows a wide range of available authentication technologies to be employed and permits the use of any of the token methods of Levels 2, 3, or 4. Successful authentication requires that the Claimant prove through a secure authentication protocol that he or she possesses and controls the token…

Level2– Level 2 provides single factor remote network authentication. At Level 2, identity proofing requirements are introduced, requiring presentation of identifying materials or information. A wide range of available authentication technologies can be employed at Level 2. For single factor authentication, Memorized Secret Tokens, Pre- Registered Knowledge Tokens, Look-up Secret Tokens, Out of Band Tokens, and Single Factor One-Time Password Devices are allowed at Level 2. Level 2 also permits any of the token methods of Levels 3 or 4. Successful authentication requires that the Claimant prove through a secure authentication protocol that he or she controls the token…

Page 30: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

30

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

Level3– Level 3 provides multi-factor remote network authentication. At least two authentication factors are required. At this level, identity proofing procedures require verification of identifying materials and information. Level 3 authentication is based on proof of possession of the allowed types of tokens through a cryptographic protocol. Multi-factor Software Cryptographic Tokens are allowed at Level 3. Level 3 also permits any of the token methods of Level 4. Level 3 authentication requires cryptographic strength mechanisms that protect the primary authentication token against compromise by the protocol threats for all threats at Level 2 as well as verifier impersonation attacks. Various types of tokens may be used as described in Section 6…

Level4– Level 4 is intended to provide the highest practical remote network authentication assurance. Level 4 authentication is based on proof of possession of a key through a cryptographic protocol. At this level, in-person identity proofing is required. Level 4 is similar to Level 3 except that only “hard” cryptographic tokens are allowed…

IdentityProofing

In order to control the authorized access to the information that is contained within the directories, data sharing rules are configured within the Salesforce platform. These rules are attached to the Profile that is associated with each User Account. Since some of the information in the SCD is protected (PHI), we require a high level of assurance (LOA) that each user is whom they claim to be. The following table outlines the LOA required for each of the directory profiles.

Profile LevelofAssurance

HPDProvider 2HPDOrganizationAdmin 2HPDPopulationAdmin 3HPDPlatformRead 2HPDPlatformWrite 3SCDPlatformRead 2SCDPlatformWrite 3SystemAdministrator 4

Page 31: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

31

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

Examples

BelowareacoupleofexamplesillustratingtheFHIRJsonencodingssupportedbythisAPI.FHIRXMLencodingsarenotsupported:

AnExampleOrganization

{ "resourceType":"Organization", "id":"Organization-1059", "meta":{ "versionId":"1", "lastUpdated":"2015-12-22T15:17:05.279-05:00" }, "extension":[ { "url":"http://org.mihin.fhir.extension.electronic-service", "valueReference":{ "reference":"ElectronicService/ElectronicService-1199", "display":"[email protected]" } } ], "identifier":[ { "use":"official", "system":"http://www.hl7.org/oid/", "value":"1.2.3.4.5.9.99.999.9999.1059" }, { "use":"official", "type":{ "coding":[ { "system":"http://hl7.org/fhir/v2/0203", "code":"NPI" } ], "text":"US National Provider Identifier"

Page 32: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

32

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

}, "system":"http://hl7.org/fhir/sid/us-npi", "value":"9999991059" } ], "active":true, "type":{ "coding":[ { "system":"NUCC", "code":"261Q00000X" } ], "text":"Clinic/Center" }, "name":"Skilled Nursing Facility", "telecom":[ { "system":"phone", "value":"616.555.8199", "use":"work" } ], "address":[ { "line":[ "221 N Missouri Circle" ], "city":"Rochester Hills", "state":"MI", "postalCode":"48307" } ] }

AnExampleOrganization“PeaceofMind”

{ "resourceType":"Organization", "id":"Organization-1099",

Page 33: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

33

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

"meta":{ "versionId":"2", "lastUpdated":"2015-12-23T06:32:33.178-05:00" }, "extension":[ { "url":"http://org.mihin.fhir.extension.electronic-service", "valueReference":{ "reference":"ElectronicService/ElectronicService-1330", "display":"[email protected]" } }, { "url":"http://org.mihin.fhir.extension.electronic-service", "valueReference":{ "reference":"ElectronicService/ElectronicService-1331", "display":"Peace of Mind" } }, { "url":"http://org.mihin.fhir.extension.service-description", "valueReference":{ "reference":"ServiceDescription/ServiceDescription-1", "display":"Advance Directive Repository" } } ], "identifier":[ { "use":"official", "system":"http://www.hl7.org/oid/", "value":"1.2.3.4.5.9.99.999.9999.1099" }, { "use":"official", "type":{ "coding":[ { "system":"http://hl7.org/fhir/v2/0203", "code":"NPI"

Page 34: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

34

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

} ], "text":"US National Provider Identifier" }, "system":"http://hl7.org/fhir/sid/us-npi", "value":"9999991099" } ], "active":true, "type":{ "coding":[ { "system":"NUCC", "code":"305S00000X" } ], "text":"Point of Service" }, "name":"Peace of Mind", "telecom":[ { "system":"phone", "value":"734.555.8614", "use":"work" } ], "address":[ { "line":[ "765 W Oak Avenue" ], "city":"Ann Arbor", "state":"MI", "postalCode":"48103" } ] }

AnExamplePractitioner

{

Page 35: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

35

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

"resourceType":"Practitioner", "id":"Practitioner-10127", "meta":{ "versionId":"1", "lastUpdated":"2016-01-11T13:56:29.272-05:00" }, "extension":[ { "url":"http://hl7.org/fhir/StructureDefinition/us-core-race", "valueCodeableConcept":{ "coding":[ { "system":"http://hl7.org/fhir/v3/Race", "code":"1002-5", "display":"Native" } ] } }, { "url":"http://hl7.org/fhir/StructureDefinition/us-core-ethnicity", "valueCodeableConcept":{ "coding":[ { "system":"http://hl7.org/fhir/v3/Ethnicity", "code":"2186-5", "display":"Native" } ] } }, { "url":"http://gov.onc.fhir.extension.taxonomy", "valueCodeableConcept":{ "coding":[ { "system":"http://org.nucc.taxonomy", "code":"208D00000X", "display":"General Practice" }

Page 36: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

36

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

] } }, { "url":"http://org.mihin.fhir.extension.electronic-service", "valueReference":{ "reference":"ElectronicService/ElectronicService-186", "display":"[email protected]" } } ], "identifier":[ { "use":"official", "type":{ "coding":[ { "system":"http://hl7.org/fhir/v2/0203", "code":"TAX" } ], "text":"US Social Security Number" }, "system":"http://hl7.org/fhir/sid/us-ssn", "value":"000010127" }, { "use":"official", "type":{ "coding":[ { "system":"http://hl7.org/fhir/v2/0203", "code":"NPI" } ], "text":"US National Provider Identifier" }, "system":"http://hl7.org/fhir/sid/us-npi", "value":"9999910127" }

Page 37: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

37

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

], "name":{ "family":[ "Park" ], "given":[ "Willie", "Benjamin" ], "suffix":[ "MD" ] }, "telecom":[ { "system":"phone", "value":"313.555.4016", "use":"home" }, { "system":"phone", "value":"313.555.6261", "use":"work" } ], "address":[ { "line":[ "550 N Mississippi Avenue" ], "city":"Taylor", "state":"MI", "postalCode":"48180" } ], "gender":"male", "birthDate":"1975-07-30", "qualification":[ { "identifier":[

Page 38: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

38

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

{ "use":"official", "type":{ "coding":[ { "system":"http://gov.michigan.fhir.medical-license-type", "code":"MD" } ], "text":"Michigan Medical License" }, "system":"http://gov.michigan.fhir.medical-license", "value":"LARA-10127", "assigner":{ "display":"State of Michigan" } } ], "issuer":{ "reference":"Organization/Organization-1001", "display":"Michigan Department of Licensing and Regulatory Affairs" } } ] }

AnExamplePatient

{ "resourceType":"Patient", "id":"Patient-1126", "meta":{ "versionId":"1", "lastUpdated":"2015-12-22T15:17:11.151-05:00" }, "extension":[ { "url":"http://hl7.org/fhir/StructureDefinition/us-core-race", "valueCodeableConcept":{ "coding":[ { "system":"http://hl7.org/fhir/v3/Race",

Page 39: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

39

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

"code":"2106-3" } ] } }, { "url":"http://hl7.org/fhir/StructureDefinition/us-core-ethnicity", "valueCodeableConcept":{ "coding":[ { "system":"http://hl7.org/fhir/v3/Ethnicity", "code":"2186-5" } ] } }, { "url":"http://hl7.org/fhir/StructureDefinition/us-core-religion", "valueCodeableConcept":{ "coding":[ { "system":"http://hl7.org/fhir/v3/ReligiousAffiliation", "code":"1041" } ] } } ], "text":{ "status":"generated", "div":"<div><div class=\"hapiHeaderText\"> Cady Grace <b>PAULSON </b></div><table class=\"hapiPropertyTable\"><tbody><tr><td>Identifier</td><td>000-00-1126</td></tr><tr><td>Address</td><td><span>640 E Hudson Circle </span><br /><span>St. Clair Shores </span><span>MI </span></td></tr><tr><td>Date of birth</td><td><span>14 December 2011</span></td></tr></tbody></table></div>" }, "identifier":[ { "use":"official", "type":{

Page 40: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

40

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

"coding":[ { "system":"http://hl7.org/fhir/v2/0203", "code":"TAX" } ], "text":"US Social Security Number" }, "system":"http://hl7.org/fhir/sid/us-ssn", "value":"000-00-1126" }, { "use":"official", "type":{ "coding":[ { "system":"http://org.mihin.fhir.patient.identifier.type", "code":"CKS" } ], "text":"MiHIN Common Key Service Id" }, "system":"http://org.mihinss/fhir/cks", "value":"ah7xjkynfl4bdznumnupokdyn67xm4x4qtuqpweb" } ], "name":[ { "family":[ "Paulson" ], "given":[ "Cady", "Grace" ] } ], "telecom":[ { "system":"phone",

Page 41: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

41

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

"value":"586.555.5105", "use":"home" }, { "system":"phone", "value":"586.555.4955", "use":"work" }, { "extension":[ { "url":"http://hl7.org/fhir/StructureDefinition/us-core-direct", "valueBoolean":true } ], "system":"email", "value":"[email protected]", "use":"home" } ], "gender":"female", "birthDate":"2011-12-14", "address":[ { "line":[ "640 E Hudson Circle" ], "city":"St. Clair Shores", "state":"MI", "postalCode":"48082" } ] }

AnExampleElectronicService

{ "resourceType":"Basic", "id":"ElectronicService-1", "meta":{

Page 42: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

42

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

"versionId":"1", "lastUpdated":"2015-12-22T15:56:58.252-05:00" }, "extension":[ { "url":"http://org.mihin.fhir.extension.electronic-service.name", "valueString":"[email protected]" }, { "url":"http://org.mihin.fhir.extension.electronic-service.destination", "valueCodeableConcept":{ "coding":[ { "system":"http://org.mihin.fhir.services", "code":"ADT" } ], "text":"[email protected]" } }, { "url":"http://org.mihin.fhir.extension.electronic-service.content", "valueCodeableConcept":{ "coding":[ { "system":"http://org.mihin.fhir.esi.content", "code":"MIME" } ], "text":"MIME Content" } }, { "url":"http://org.mihin.fhir.extension.electronic-service.integration", "valueCodeableConcept":{ "coding":[ { "system":"http://org.mihin.fhir.esi.integration", "code":"Direct" }

Page 43: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

43

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

], "text":"Direct SMTP" } }, { "url":"http://org.mihin.fhir.extension.electronic-service.address", "valueString":"[email protected]" } ], "code":{ "coding":[ { "system":"http://org.mihin.fhir.extension.electronic-service" } ], "text":"Electronic Service" } }

AnExampleMembership

{ "resourceType":"Basic", "id":"Membership-760", "meta":{ "versionId":"1", "lastUpdated":"2015-12-22T16:04:38.016-05:00" }, "extension":[ { "url":"http://org.mihin.fhir.extension.membership.type", "valueCodeableConcept":{ "coding":[ { "system":"http://org.mihin.fhir.practitioner.membership.type", "code":"Member Of" } ], "text":"Practitioner Membership" }

Page 44: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

44

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

}, { "url":"http://org.mihin.fhir.extension.membership.organization", "valueReference":{ "reference":"Organization/Organization-1025", "display":"Health Care Professionals" } }, { "url":"http://org.mihin.fhir.extension.membership.member", "valueReference":{ "reference":"Practitioner/Practitioner-10304", "display":"Nancy Delacruz Elliott MD" } }, { "url":"http://org.mihin.fhir.extension.membership.period", "valuePeriod":{ "start":"2015-12-22T15:59:06-05:00" } } ], "code":{ "coding":[ { "system":"http://org.mihin.fhir.extension.membership" } ], "text":"Membership" } }

AnExampleActiveCareRelationship

{ "resourceType":"Basic", "id":"ActiveCareRelationship-2000", "meta":{ "versionId":"2", "lastUpdated":"2015-12-23T06:37:07.235-05:00" },

Page 45: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

45

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

"extension":[ { "url":"http://org.mihin.fhir.extension.active-care-relationship.administrator", "valueReference":{ "reference":"Organization/Organization-1022", "display":"Sunnyside Physicians" } }, { "url":"http://org.mihin.fhir.extension.active-care-relationship.patient", "valueReference":{ "reference":"Patient/Patient-11327", "display":"Caroline Collins Werner" } }, { "url":"http://org.mihin.fhir.extension.active-care-relationship.provider", "valueReference":{ "reference":"Practitioner/Practitioner-10076", "display":"Gina Wilkins Long MD" } }, { "url":"http://org.mihin.fhir.extension.active-care-relationship.practice", "valueReference":{ "reference":"Organization/Organization-1043", "display":"Southwest Family Medicine" } }, { "url":"http://org.mihin.fhir.extension.active-care-relationship.period", "valuePeriod":{ "start":"2021-11-10T20:46:09-05:00" } } ], "code":{ "coding":[ { "system":"http://org.mihin.fhir.extension.active-care-relationship"

Page 46: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

46

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

} ], "text":"Active Care Relationship" } }

AnExampleContractforaConsentDirective

{ "resourceType": "Contract", "id": "Contract-82", "issued": "2016-01-06T14:01:33-05:00", "subject": [ { "reference": "Patient/Patient-1132", "display": "Alex Ramirez Gonzales" } ], "type": { "coding": [ { "system": "http://org.mdch.fhir.consent-type", "code": "EX" } ], "text": "All regulated health information except excluded subtypes" }, "subType": [ { "coding": [ { "system": "http://org.mdch.fhir.consent-subtype", "code": "ASD" } ], "text": "Referrals and treatment for alcohol and substance use disorder" } ], "actor": [ { "entity": {

Page 47: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

47

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

"reference": "Organization/Organization-1101", "display": "West Lake Clinic" }, "role": [ { "coding": [ { "system": "http://org.mdch.fhir.consent-actor-type", "code": "IR", "display": "Recipient" } ], "text": "Recipient of restricted health information" } ] }, { "entity": { "reference": "Organization/Organization-1100", "display": "East Lansing General Hospital" }, "role": [ { "coding": [ { "system": "http://org.mdch.fhir.consent-actor-type", "code": "IR", "display": "Recipient" } ], "text": "Recipient of restricted health information" } ] } ], "signer": [ { "type": { "system": "http://org.mdch.fhir.consent-signer-type", "code": "SELF"

Page 48: Statewide Health Consumer FHIR APIs · 2018-07-13 · This API supports the United States Realm FHIR Profile extensions to encode optional race, ethnicity and religion attributes

48

For information visit www.mihin.org or contact [email protected] Copyright 2015 Michigan Health Information Network Shared Services

}, "party": { "reference": "Patient/Patient-1132", "display": "Alex Ramirez Gonzales" }, "signature": "Alex Gonzales " } ], "legal": [ { "contentAttachment": { "contentType": "application/pdf", "language": "en-US", "url": "http://org.mihin.ecms/ConsentDirective-82", "title": "MDCH Consent To Share Your Health Information" } } ] }