Specialty Medication Enrollment
2.1.0 - CI Build

Specialty Medication Enrollment, published by HL7 International - Pharmacy. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/fhir-specialty-rx/ and changes regularly. See the Directory of published versions

## Example Bundle: Specialty Rx Query Response 1

### Example data content

expand all | contract all Bundle
id@value: specialty-rx-query-response-1
meta profile@value: http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-bundle-query-response
type@value: message
timestamp@value: 2020-03-11T08:10:17-05:00 entry[1]fullUrl@value: urn:uuid:d0b62e34-db4a-4ef7-832c-52cb4c7f9289
resource MessageHeader
id@value: 72f68739-f49a-4536-b8d4-15f57197abde
meta profile@value: http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-messageheader-query-response
eventCoding system@value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-event-type code@value: query-response display@value: Query Response
source name@value: Specialty Sandbox Static endpoint@value: http://example.org/MyEHR/$process-message
response identifier@value: 5065aa9f-bd6d-49a8-924c-5d00f5d0b997 code@value: ok
focus reference@value: urn:uuid:b5000d0c-fed9-4746-ac26-b5ce0111a2b7
entry[2]fullUrl@value: urn:uuid:b5000d0c-fed9-4746-ac26-b5ce0111a2b7
resource Parameters
id@value: b5000d0c-fed9-4746-ac26-b5ce0111a2b7
meta profile@value: http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-parameters-query-response parameter[1]name@value: responder-patient valueReference reference@value: http://example.org/MyEHR/Patient/patientEHR
parameter[2]name@value: requester-patient valueReference reference@value: urn:uuid:2a87e733-8fe5-4dca-a9ae-bb24c36d41aa
parameter[3]name@value: search-result valueReference reference@value: urn:uuid:aecbb129-9a73-4b59-9d66-ff5cdb3f3164
parameter[4]name@value: search-result valueReference reference@value: urn:uuid:9ce2a97b-5cab-4986-814f-4734016e6084
parameter[5]name@value: search-result valueReference reference@value: urn:uuid:53a1e123-5b56-44ae-b7e8-36e0b9800f57
parameter[6]name@value: search-result valueReference reference@value: urn:uuid:82ae67e4-f23a-4c17-b80a-9076a37f5d6e
parameter[7]name@value: search-result valueReference reference@value: urn:uuid:6b28b7d5-95e1-485b-a0bc-2420a20635a8
parameter[8]name@value: search-result valueReference reference@value: urn:uuid:89b0b6ce-4a31-4718-b38a-798efab6c9e4
entry[3]fullUrl@value: http://example.org/MyEHR/Patient/patientEHR
resource Patient
id@value: patientEHR
meta profile@value: http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-patient
identifier type coding system@value: http://terminology.hl7.org/CodeSystem/v2-0203 code@value: MR display@value: Medical record number
text@value: Medical record number
system@value: http://example.org/MyEHR value@value: 30455
active@value: true
name family@value: Doe given@value: Tim telecom[1]system@value: phone value@value: 555-555-5555 use@value: home
telecom[2]system@value: email value@value: tim.doe@example.com gender@value: male
birthDate@value: 1987-02-20
address line@value: 2224 Century Avenue city@value: Minnetonka state@value: MN postalCode@value: 55345 country@value: US
communication language coding system@value: urn:ietf:bcp:47 code@value: en-US display@value: English (Region=United States)
entry[4]fullUrl@value: urn:uuid:2a87e733-8fe5-4dca-a9ae-bb24c36d41aa
resource Patient
id@value: 2a87e733-8fe5-4dca-a9ae-bb24c36d41aa
meta profile@value: http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-patient identifier[1]type coding system@value: http://terminology.hl7.org/CodeSystem/v2-0203 code@value: PI display@value: Patient internal identifier
system@value: http://example.org/MyPharmacyApp/patient-id value@value: 540002
identifier[2]type coding system@value: http://terminology.hl7.org/CodeSystem/v2-0203 code@value: MR display@value: Medical record number
text@value: MRN from prescription
system extension@url: http://hl7.org/fhir/StructureDefinition/data-absent-reason valueCode@value: unknown
value@value: 30455 active@value: true
name family@value: Doe given@value: Tim telecom[1]system@value: phone value@value: 555-555-5555 use@value: home
telecom[2]system@value: email value@value: tim.doe@example.com gender@value: male
birthDate@value: 1987-02-20
address line@value: 2224 Century Avenue city@value: Minnetonka state@value: MN postalCode@value: 55345 country@value: US
communication language coding system@value: urn:ietf:bcp:47 code@value: en-US display@value: English (Region=United States)
entry[5]fullUrl@value: urn:uuid:aecbb129-9a73-4b59-9d66-ff5cdb3f3164
resource Bundle
id@value: aecbb129-9a73-4b59-9d66-ff5cdb3f3164
meta profile@value: http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-bundle-search-result
type@value: searchset
total@value: 3
link relation@value: self url@value: AllergyIntolerance?clinical-status=active&patient=patientEHR entry[1]fullUrl@value: http://example.org/MyEHR/AllergyIntolerance/1
resource AllergyIntolerance
id@value: 1
clinicalStatus coding system@value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical code@value: active display@value: Active
verificationStatus coding system@value: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification code@value: confirmed display@value: Confirmed
code text@value: Cashew
patient reference@value: Patient/patientEHR
search mode@value: match
entry[2]fullUrl@value: http://example.org/MyEHR/AllergyIntolerance/2
resource AllergyIntolerance
id@value: 2
clinicalStatus coding system@value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical code@value: active display@value: Active
verificationStatus coding system@value: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification code@value: confirmed display@value: Confirmed
code text@value: Bees
patient reference@value: Patient/patientEHR
search mode@value: match
entry[3]fullUrl@value: http://example.org/MyEHR/AllergyIntolerance/3
resource AllergyIntolerance
id@value: 3
clinicalStatus coding system@value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical code@value: active display@value: Active
verificationStatus coding system@value: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification code@value: confirmed display@value: Confirmed
code text@value: Penicillins
patient reference@value: Patient/patientEHR
reaction manifestation text@value: Hives
search mode@value: match
entry[6]fullUrl@value: urn:uuid:9ce2a97b-5cab-4986-814f-4734016e6084
resource Bundle
id@value: 9ce2a97b-5cab-4986-814f-4734016e6084
meta profile@value: http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-bundle-search-result
type@value: searchset
total@value: 3
link relation@value: self url@value: Condition?clinical-status=active&patient=patientEHR entry[1]fullUrl@value: http://example.org/MyEHR/Condition/1
resource Condition
id@value: 1
meta profile@value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition
clinicalStatus coding system@value: http://terminology.hl7.org/CodeSystem/condition-clinical code@value: active display@value: Active
text@value: Active
verificationStatus coding system@value: http://terminology.hl7.org/CodeSystem/condition-ver-status code@value: confirmed display@value: Confirmed
text@value: Confirmed
category coding system@value: http://terminology.hl7.org/CodeSystem/condition-category code@value: problem-list-item display@value: Problem List Item
text@value: Problem
code coding system@value: http://snomed.info/sct code@value: 13644009 display@value: Hypercholesterolemia (disorder)
text@value: Hypercholesterolemia (disorder)
subject reference@value: Patient/patientEHR
search mode@value: match
entry[2]fullUrl@value: http://example.org/MyEHR/Condition/2
resource Condition
id@value: 2
meta profile@value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition
clinicalStatus coding system@value: http://terminology.hl7.org/CodeSystem/condition-clinical code@value: active display@value: Active
text@value: Active
verificationStatus coding system@value: http://terminology.hl7.org/CodeSystem/condition-ver-status code@value: confirmed display@value: Confirmed
text@value: Confirmed
category coding system@value: http://terminology.hl7.org/CodeSystem/condition-category code@value: problem-list-item display@value: Problem List Item
text@value: Problem
code coding system@value: http://snomed.info/sct code@value: 84172003 display@value: Spondylitis (disorder)
text@value: Spondylitis (disorder)
subject reference@value: Patient/patientEHR
search mode@value: match
entry[3]fullUrl@value: http://example.org/MyEHR/Condition/3
resource Condition
id@value: 3
meta profile@value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition
clinicalStatus coding system@value: http://terminology.hl7.org/CodeSystem/condition-clinical code@value: active display@value: Active
text@value: Active
verificationStatus coding system@value: http://terminology.hl7.org/CodeSystem/condition-ver-status code@value: confirmed display@value: Confirmed
text@value: Confirmed
category coding system@value: http://terminology.hl7.org/CodeSystem/condition-category code@value: problem-list-item display@value: Problem List Item
text@value: Problem
code coding system@value: http://snomed.info/sct code@value: 427603009 display@value: Intermittent asthma (disorder)
text@value: Intermittent asthma (disorder)
subject reference@value: Patient/patientEHR
search mode@value: match
entry[7]fullUrl@value: urn:uuid:53a1e123-5b56-44ae-b7e8-36e0b9800f57
resource Bundle
id@value: 53a1e123-5b56-44ae-b7e8-36e0b9800f57
meta profile@value: http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-bundle-search-result
type@value: searchset
total@value: 1
link relation@value: self url@value: Coverage?patient=patientEHR
entry fullUrl@value: http://example.org/MyEHR/Coverage/coverage-1
resource Coverage
id@value: coverage-1
meta profile@value: http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-coverage
status@value: active
beneficiary reference@value: Patient/patientEHR
payor identifier value@value: Pharmacy Plans US class[1]type coding system@value: http://terminology.hl7.org/CodeSystem/coverage-class code@value: rxbin
value@value: 560564
class[2]type coding system@value: http://terminology.hl7.org/CodeSystem/coverage-class code@value: rxpcn
value@value: HMMK
class[3]type coding system@value: http://terminology.hl7.org/CodeSystem/coverage-class code@value: rxgroup
value@value: SILVER0334
class[4]type coding system@value: http://terminology.hl7.org/CodeSystem/coverage-class code@value: rxid
value@value: JSO1345505608801
search mode@value: match
entry[8]fullUrl@value: urn:uuid:82ae67e4-f23a-4c17-b80a-9076a37f5d6e
resource Bundle
id@value: 82ae67e4-f23a-4c17-b80a-9076a37f5d6e
meta profile@value: http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-bundle-search-result
type@value: searchset
total@value: 0
link relation@value: self url@value: Observation?category=vital-signs&patient=patientEHR
entry[9]fullUrl@value: urn:uuid:6b28b7d5-95e1-485b-a0bc-2420a20635a8
resource Bundle
id@value: 6b28b7d5-95e1-485b-a0bc-2420a20635a8
meta profile@value: http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-bundle-search-result
type@value: searchset
total@value: 1
link relation@value: self url@value: Observation?category=laboratory&patient=patientEHR
entry fullUrl@value: http://example.org/MyEHR/Observation/observation-1
resource Observation
id@value: observation-1
meta versionId@value: 206588 lastUpdated@value: 2019-04-18T04:10:12.426+00:00 profile@value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab
status@value: final
category coding system@value: http://terminology.hl7.org/CodeSystem/observation-category code@value: laboratory display@value: Laboratory
text@value: Laboratory
code coding system@value: http://loinc.org code@value: 5811-5 display@value: Specific gravity of Urine by Test strip
text@value: SPEC GRAV
subject reference@value: Patient/patientEHR display@value: Tim Doe
effectiveDateTime@value: 2019-04-18
valueQuantity value@value: 1.017 system@value: http://unitsofmeasure.org code@value: {urine specific gravity}
referenceRange low value@value: 1.003 system@value: http://unitsofmeasure.org code@value: {urine specific gravity}
high value@value: 1.035 system@value: http://unitsofmeasure.org code@value: {urine specific gravity}
search mode@value: match
entry[10]fullUrl@value: urn:uuid:89b0b6ce-4a31-4718-b38a-798efab6c9e4
resource Bundle
id@value: 89b0b6ce-4a31-4718-b38a-798efab6c9e4
meta profile@value: http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-bundle-search-result
type@value: searchset
total@value: 1
link relation@value: self url@value: MedicationRequest?patient=patientEHR
entry fullUrl@value: http://example.org/MyEHR/MedicationRequest/prescription-1
resource MedicationRequest
id@value: prescription-1
status@value: stopped
intent@value: order
medicationCodeableConcept coding system@value: http://www.nlm.nih.gov/research/umls/rxnorm code@value: 802652 display@value: 1 ML Enbrel 50 MG/ML Prefilled Syringe
subject reference@value: Patient/patientEHR
authoredOn@value: 2020-05-11
requester reference@value: http://example.org/MyEHR/Practitioner/50645003
dispenseRequest quantity value@value: 4 unit@value: {each}
expectedSupplyDuration value@value: 30 unit@value: days system@value: http://unitsofmeasure.org code@value: d
performer reference@value: http://example.org/MyEHR/Organization/pharmacy-305660
substitution allowedBoolean@value: false
search mode@value: match

### Generated Narrative

Bundle specialty-rx-query-response-1 of type message

Entry 1 - fullUrl = urn:uuid:d0b62e34-db4a-4ef7-832c-52cb4c7f9289

Resource MessageHeader:

> Generated Narrative: MessageHeader

> Resource MessageHeader "72f68739-f49a-4536-b8d4-15f57197abde"

> Profile: Specialty Rx Query Response MessageHeader

> event: Query Response (Details: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-event-type code query-response = 'Query Response', stated as 'Query Response')

> ### Sources

> - | Name | Endpoint
> * | Specialty Sandbox Static | http://example.org/MyEHR/$process-message

> ### Responses

> - | Identifier | Code
> * | id: 5065aa9f-bd6d-49a8-924c-5d00f5d0b997 | OK

> focus: See above (urn:uuid:b5000d0c-fed9-4746-ac26-b5ce0111a2b7)

Entry 2 - fullUrl = urn:uuid:b5000d0c-fed9-4746-ac26-b5ce0111a2b7

Resource Parameters:

> ## Parameters

> responder-patient | http://example.org/MyEHR/Patient/patientEHR
> requester-patient | urn:uuid:2a87e733-8fe5-4dca-a9ae-bb24c36d41aa
> search-result | urn:uuid:aecbb129-9a73-4b59-9d66-ff5cdb3f3164
> search-result | urn:uuid:9ce2a97b-5cab-4986-814f-4734016e6084
> search-result | urn:uuid:53a1e123-5b56-44ae-b7e8-36e0b9800f57
> search-result | urn:uuid:82ae67e4-f23a-4c17-b80a-9076a37f5d6e
> search-result | urn:uuid:6b28b7d5-95e1-485b-a0bc-2420a20635a8
> search-result | urn:uuid:89b0b6ce-4a31-4718-b38a-798efab6c9e4

Entry 3 - fullUrl = http://example.org/MyEHR/Patient/patientEHR

Resource Patient:

> Tim Doe Male, DoB: 1987-02-20 ( Medical record number: 30455)

Entry 4 - fullUrl = urn:uuid:2a87e733-8fe5-4dca-a9ae-bb24c36d41aa

Resource Patient:

> Tim Doe Male, DoB: 1987-02-20 ( Patient internal identifier: 540002)

Entry 5 - fullUrl = urn:uuid:aecbb129-9a73-4b59-9d66-ff5cdb3f3164

Resource Bundle:

> Bundle aecbb129-9a73-4b59-9d66-ff5cdb3f3164 of type searchset

> Entry 1 - fullUrl = http://example.org/MyEHR/AllergyIntolerance/1

> Search:Mode = match

> Resource AllergyIntolerance:

> > Generated Narrative: AllergyIntolerance

> > Resource AllergyIntolerance "1"

> > clinicalStatus: Active (AllergyIntolerance Clinical Status Codes#active)

> > verificationStatus: Confirmed (AllergyIntolerance Verification Status#confirmed)

> > code: Cashew ()

> > patient: See above (Patient/patientEHR)

> Entry 2 - fullUrl = http://example.org/MyEHR/AllergyIntolerance/2

> Search:Mode = match

> Resource AllergyIntolerance:

> > Generated Narrative: AllergyIntolerance

> > Resource AllergyIntolerance "2"

> > clinicalStatus: Active (AllergyIntolerance Clinical Status Codes#active)

> > verificationStatus: Confirmed (AllergyIntolerance Verification Status#confirmed)

> > code: Bees ()

> > patient: See above (Patient/patientEHR)

> Entry 3 - fullUrl = http://example.org/MyEHR/AllergyIntolerance/3

> Search:Mode = match

> Resource AllergyIntolerance:

> > Generated Narrative: AllergyIntolerance

> > Resource AllergyIntolerance "3"

> > clinicalStatus: Active (AllergyIntolerance Clinical Status Codes#active)

> > verificationStatus: Confirmed (AllergyIntolerance Verification Status#confirmed)

> > code: Penicillins ()

> > patient: See above (Patient/patientEHR)

> > ### Reactions

> > - | Manifestation
> > * | Hives ()

Entry 6 - fullUrl = urn:uuid:9ce2a97b-5cab-4986-814f-4734016e6084

Resource Bundle:

> Bundle 9ce2a97b-5cab-4986-814f-4734016e6084 of type searchset

> Entry 1 - fullUrl = http://example.org/MyEHR/Condition/1

> Search:Mode = match

> Resource Condition:

> > Generated Narrative: Condition

> > Resource Condition "1"

> > Profile: US Core Condition Profile

> > clinicalStatus: Active (Condition Clinical Status Codes#active)

> > verificationStatus: Confirmed (ConditionVerificationStatus#confirmed)

> > category: Problem (Condition Category Codes#problem-list-item "Problem List Item")

> > code: Hypercholesterolemia (disorder) (SNOMED CT#13644009)

> > subject: See above (Patient/patientEHR)

> Entry 2 - fullUrl = http://example.org/MyEHR/Condition/2

> Search:Mode = match

> Resource Condition:

> > Generated Narrative: Condition

> > Resource Condition "2"

> > Profile: US Core Condition Profile

> > clinicalStatus: Active (Condition Clinical Status Codes#active)

> > verificationStatus: Confirmed (ConditionVerificationStatus#confirmed)

> > category: Problem (Condition Category Codes#problem-list-item "Problem List Item")

> > code: Spondylitis (disorder) (SNOMED CT#84172003)

> > subject: See above (Patient/patientEHR)

> Entry 3 - fullUrl = http://example.org/MyEHR/Condition/3

> Search:Mode = match

> Resource Condition:

> > Generated Narrative: Condition

> > Resource Condition "3"

> > Profile: US Core Condition Profile

> > clinicalStatus: Active (Condition Clinical Status Codes#active)

> > verificationStatus: Confirmed (ConditionVerificationStatus#confirmed)

> > category: Problem (Condition Category Codes#problem-list-item "Problem List Item")

> > code: Intermittent asthma (disorder) (SNOMED CT#427603009)

> > subject: See above (Patient/patientEHR)

Entry 7 - fullUrl = urn:uuid:53a1e123-5b56-44ae-b7e8-36e0b9800f57

Resource Bundle:

> Bundle 53a1e123-5b56-44ae-b7e8-36e0b9800f57 of type searchset

> Entry 1 - fullUrl = http://example.org/MyEHR/Coverage/coverage-1

> Search:Mode = match

> Resource Coverage:

> > Generated Narrative: Coverage

> > Resource Coverage "coverage-1"

> > Profile: Specialty Rx Coverage

> > status: ACTIVE

> > beneficiary: See above (Patient/patientEHR)

> > > class

> > > type: RX BIN (Coverage Class Codes#rxbin)

> > > value: id: 560564

> > > class

> > > type: RX PCN (Coverage Class Codes#rxpcn)

> > > value: id: HMMK

> > > class

> > > type: RX Group (Coverage Class Codes#rxgroup)

> > > value: id: SILVER0334

> > > class

> > > type: RX Id (Coverage Class Codes#rxid)

> > > value: id: JSO1345505608801

Entry 8 - fullUrl = urn:uuid:82ae67e4-f23a-4c17-b80a-9076a37f5d6e

Resource Bundle:

> Bundle 82ae67e4-f23a-4c17-b80a-9076a37f5d6e of type searchset

Entry 9 - fullUrl = urn:uuid:6b28b7d5-95e1-485b-a0bc-2420a20635a8

Resource Bundle:

> Bundle 6b28b7d5-95e1-485b-a0bc-2420a20635a8 of type searchset

> Entry 1 - fullUrl = http://example.org/MyEHR/Observation/observation-1

> Search:Mode = match

> Resource Observation:

> > Generated Narrative: Observation

> > Resource Observation "observation-1" Version "206588" Updated "2019-04-18 04:10:12+0000"

> > Profile: US Core Laboratory Result Observation Profile

> > status: FINAL

> > category: Laboratory (Observation Category Codes#laboratory)

> > code: SPEC GRAV (LOINC#5811-5 "Specific gravity of Urine by Test strip")

> > subject: See above (Patient/patientEHR: Tim Doe)

> > effective: 2019-04-18

> > value: 1.017 {urine specific gravity} (Details: UCUM code {urine specific gravity} = '{urine specific gravity}')

> > ### ReferenceRanges

> > - | Low | High
> > * | 1.003 {urine specific gravity} (Details: UCUM code {urine specific gravity} = '{urine specific gravity}') | 1.035 {urine specific gravity} (Details: UCUM code {urine specific gravity} = '{urine specific gravity}')

Entry 10 - fullUrl = urn:uuid:89b0b6ce-4a31-4718-b38a-798efab6c9e4

Resource Bundle:

> Bundle 89b0b6ce-4a31-4718-b38a-798efab6c9e4 of type searchset

> Entry 1 - fullUrl = http://example.org/MyEHR/MedicationRequest/prescription-1

> Search:Mode = match

> Resource MedicationRequest:

> > Generated Narrative: MedicationRequest

> > Resource MedicationRequest "prescription-1"

> > status: STOPPED

> > intent: ORDER

> > subject: See above (Patient/patientEHR)

> > authoredOn: 2020-05-11

> > requester: http://example.org/MyEHR/Practitioner/50645003

> > > dispenseRequest

> > > quantity: 4 {each}

> > > ### ExpectedSupplyDurations

> > > - | Value | Unit | System | Code
> > > * | 30 | days | Unified Code for Units of Measure (UCUM) | d

> > ### Substitutions

> > - | Allowed[x]
> > * | false