Resource Profile: Bundle_SPOClinicalInformationRequest_General

This profile sets the expectations for the Bundle resource. It identifies the mandatory core elements, extensions, vocabularies, and value sets which SHALL be present in the Bundle as well as optional elements when using this profile.

This Bundle profile describes the components of the general SPOClinicalInformationRequest (aka general callback), a request sent in response to SPOInitiationRequest messages accepted for processing, which requests the following clinical information for the patient being prescribed a specialty medication -- current allergies/medications/problems and most recent clinical note/height/weight.

A Bundle_SPOClinicalInformationRequest_General always includes these components (FHIR resources):

  1. MessageHeader_SPOClinicalInformationRequest_General - must be the first entry in the FHIR Bundle.
  2. Parameters_SPOClinicalInformationRequest_ActiveAllergiesQuery - the query (request) for the current (i.e., status = active) allergies or intolerances for a specific patient. The data should be returned as a set of AllergyIntolerance resources when there are known substances to which the patient is allergic or has an intolerance to.
  3. Parameters_SPOClinicalInformationRequest_ActiveProblemsQuery - the query for the current (i.e., status = active) problems for a specific patient. The data should be returned as a set of Condition resources, one for each active patient problem.
  4. Parameters_SPOClinicalInformationRequest_ActiveMedicationsQuery - the query for the current (i.e., status = active) medications for a specific patient. The data should be returned as a set of MedicationStatement resources, one for each active patient medication.
  5. Parameters_SPOClinicalInformationRequest_LatestBodyHeightQuery - the query for the most recent body height for a specific patient. The data should be returned in an Observation resource.
  6. Parameters_SPOClinicalInformationRequest_LatestBodyWeightQuery - the query for the most recent body weight for a specific patient. The data should be returned as an Observation resource.
  7. Parameters_SPOClinicalInformationRequest_LatestClinicalNoteQuery - the query for the most recent clinical note for a specific patient. The data should be returned as a Document resource.

Example

Formal View of Profile Content

This profile builds on Bundle. For additional information on the table definitions shown below, see the Logical Table section on the Resource Formats page.

Notes: Click the tabs below to see the different views for the profile:

  • The Full View shows all the base resource element information for the profile plus the Surescripts requirements.
  • The Hybrid View shows all the element information, but the unchanged information from the base resource is greyed out.
  • The Differential View only shows the changes made to the base resource (i.e., the Surescripts requirements).

Full View

identifierΣ0..1Identifier
typeΣ1..1codeBindingFixed Value
timestampΣ1..1instant
totalΣ I0..1unsignedInt
relationΣ1..1string
urlΣ1..1uri
fullUrlΣ0..1uri
resourceΣ0..1Resource
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceS Σ I1..1MessageHeader_SPOClinicalInformationRequest_General
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_ActiveAllergiesQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_AciveProblemsQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_ActiveMedicationsQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_LatestBodyHeightQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_LatestBodyWeightQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_LatestClinicalNoteQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature

Hybrid View

identifierΣ0..1Identifier
typeΣ1..1codeBindingFixed Value
timestampΣ1..1instant
totalΣ I0..1unsignedInt
relationΣ1..1string
urlΣ1..1uri
fullUrlΣ0..1uri
resourceΣ0..1Resource
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceS Σ I1..1MessageHeader_SPOClinicalInformationRequest_General
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_ActiveAllergiesQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_AciveProblemsQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_ActiveMedicationsQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_LatestBodyHeightQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_LatestBodyWeightQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_LatestClinicalNoteQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature

Differential View

identifierΣ0..1Identifier
typeΣ1..1codeBindingFixed Value
timestampΣ1..1instant
totalΣ I0..1unsignedInt
relationΣ1..1string
urlΣ1..1uri
fullUrlΣ0..1uri
resourceΣ0..1Resource
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceS Σ I1..1MessageHeader_SPOClinicalInformationRequest_General
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_ActiveAllergiesQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_AciveProblemsQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_ActiveMedicationsQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_LatestBodyHeightQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_LatestBodyWeightQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
fullUrlΣ1..1uri
resourceΣ1..1Parameters_SPOClinicalInformationRequest_LatestClinicalNoteQuery
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature

Note: Description of Profiles, Differentials, and Snapshots