Interconnect FHIR® MPI Load

introduction customers use fhir® messages to provide surescripts health information network their member roster of patients that have given consent to be populated in the surescripts health information network interconnect mpi surescripts health information network uses that data from the customer to establish uniqueness for individuals across all customers surescripts health information network search process uses demographics to identify a patient and then uses the customer’s unique member id to communicate with the requesting and responding locations some things to consider with the fhir mpi load messages to load patients to the interconnect mpi, customers will use the fhir patient resource the message will be a post with only a patient fhir payload surescripts health information network supports json and xml messages for the fhir mpi load http headers are required see http request header docid\ pgoan0iv2cgvfftx7axno section for more information surescripts health information network uses the active field in the fhir patient resource to determine whether to set the expiration date for sharing the patient active = true indicates the patient can be shared (mpi expiration date should be null/empty) active = false indicates the patient cannot be shared (mpi expiration date should be set to the system date) active = empty fhir processing will default to false and the patient will be inactivated (mpi expiration date will be set to the system date) note if the patient opts out of information sharing from a specific customer, they should be excluded or inactivated from the mpi file load interconnect fhir mpi load process flow the customer sends surescripts health information network a message that contains the patient demographic information using the fhir patient resource to load the mpi note in the fhir patient resource, there is an indicator for active/inactive patient if the patient should be included in the mpi, it is set as “active = true” if the patient needs to be inactivated or opted out, set this indicator as “active = false” surescripts health information network populates the interconnect mpi with the patient demographic information surescripts health information network responds with an http response indicating the process success or failure details endpoints for interconnect fhir mpi load reach out to your surescripts health information network implementation resource or reference the surescripts connectivity guide for endpoint information for the interconnect mpi load requirement designation code description mandatory the element must be used per the specification (e g , xml schema validation) note the term mandatory applies to mandatory and required fields in the different standards for example, fhir uses the term required conditional the element must be used per the conditions specified recommended surescripts health information network recommends sending the element as a best practice optional some fields do not have specific conditions data should be sent if available http request header elements field code comment accept mandatory the accept request header field can be used to specify certain media types which are acceptable for the response values application/fhir+xml application/fhir+json content length mandatory used to indicate the total length of the request by character count example 301 content type mandatory the content type header is to specify the media type of the content being sent for more information see the content types and encodings docid\ pgoan0iv2cgvfftx7axno section below values application/fhir+xml application/fhir+json originator home community id mandatory identifying oid (home community id) for the sender of the patient match request example urn\ oid 1 3 840 86667 42 1 originator message id mandatory used in message audit and highly valuable for support questions surescripts health information network requires the message id to be globally unique a maximum length of 255 characters is permitted example 3bb7cae9 e835 4844 a3ae 1c41abcea564 note additional fields that are not mandatory can be sent in the http header surescripts health information network will ignore those fields but will not reject the message http request header examples request example accept application/fhir+json content type application/fhir+json; charset=utf 8 originator home community id urn\ oid 2 11 222 3 444444 5 666 originator organization name abc clinic originator message id 3bb7cae9 e835 4844 a3ae 1c41abcea564 response example content type application/fhir+json; charset=utf 8 content types and encodings according to section 3 1 0 1 9 of the fhir® specification content types and encodings, “the formal mime type for fhir resources is application/fhir+json or application/fhir+xml the correct mime type shall be used by clients and servers ” later in that same section, “utf 8 encoding shall be used for the mime type application/fhir this may be specified as a mime type parameter to the application/fhir mime type, but is not required ” because of these requirements, requests/responses will need to include a content type in the http header below is an example content type application/fhir+json; charset=utf 8 note charset=utf 8 is not required by surescripts health information network, but is supported if sent interconnect fhir mpi load element requirements the table below outlines the requirements for the patient https //hl7 org/fhir/r4/patient html resource used for loading patients to the surescripts health information network interconnect mpi note this guide includes data elements only where surescripts health information network has specific requirements or further explains the field usage refer to the patient https //hl7 org/fhir/r4/patient html fhir resource for a complete list of fields element code cardinality type comment patient domain resource information about an individual receiving health care services identifier mandatory 1 identifier an identifier for this patient name mandatory 0 human name a name associated with the patient family mandatory 1 1 string family name (often called ‘surname’) given mandatory 1 string given names (not always ‘first’) includes middle names prefix optional 0 string parts that come before the name suffix optional 0 string parts that come after the name telecom optional 0 contact point a contact detail for the individual system optional 0 1 code telecommunications form for contact point – what communications system is required to make use of the contact values phone | fax | email | pager | url | sms | other value optional 0 1 string the actual contact point details, in a form that is meaningful to the designated communication system (i e phone number or email address) gender mandatory 1 1 code administrative gender – the gender that the patient is considered to have for administration and record keeping purposes values male | female | other | unknown birthdate mandatory 1 1 date the date of birth of the individual address mandatory 1 address an address for the individual may need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification patient may have multiple addresses with different uses or applicable periods line mandatory 1 string street name, number, direction & p o box etc this component contains the house number, apartment number, street name, street direction, p o box number, delivery hints, and similar address information city mandatory 1 1 string the name of the city, town, suburb, village or other community or delivery center state mandatory 1 1 string sub unit of a country with limited sovereignty in a federally organized country a code may be used if codes are in common use (e g us 2 letter state codes) postalcode mandatory 1 1 string postal code for area interconnect fhir mpi load message example fhir mpi load message example { "resourcetype" "patient", "id" "example patientmpiload patient", "identifier" \[ { "use" "usual", "type" { "coding" \[ { "system" "http //hl7 org/fhir/v2/0203", "code" "mr" } ] }, "system" "5 22 2019 1557 003", "value" "sgcwsrkqhp", "period" { "start" "2001 05 06" }, "assigner" { "display" "acme healthcare" } } ], "active" "true", "name" \[ { "use" "official", "family" "riveiro", "given" \[ "elise", "ghm7dlgpfc" ] } ], "telecom" \[ { "system" "phone", "value" "9525553230", "use" "home" } ], "gender" "female", "birthdate" "1969 05 22", "address" { "use" "home", "line" \[ "1616 warbler lane", "" ], "city" "saint paul", "state" "mn", "postalcode" "55344" } }