US Core Implementation Guide
5.0.0 - STU5 Release US

This page is part of the US Core (v5.0.0: STU5) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

Resource Profile: US Core QuestionnaireResponse Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-questionnaireresponse Version: 5.0.0
Active as of 2022-04-20 Computable Name: USCoreQuestionnaireResponseProfile

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the QuestionnaireResponse resource to record, search, and fetch retrieve captures the responses to form/survey and assessment tools such as the Protocol for Responding to and Assessing Patients’ Assets, Risks, and Experiences (PRAPARE) Survey. This profile is based on the Structured Data Capture (SDC) Questionnaire Response Profile and identifies the additional core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile. It provides the floor for standards development for specific uses cases.

Example Usage Scenarios:

The following are example usage scenarios for this profile:

  • Query for survey screening results for a patient.
  • Record or update screening results results belonging to a Patient

Mandatory and Must Support Data Elements

In addition to the mandatory and must support data elements in the SDC QuestionnaireResponse Profile, the following data-elements must always be present (Mandatory definition]) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements. Note that the Must Support view aggregates all the must support elements between this profile and its parent profiles.

Each QuestionnaireResponse must have:

  1. a reference back to the assessment upon which it is based
  2. a status
  3. a patient
  4. the date the answers were gathered

Each QuestionnaireResponse must support:

  1. a tag to indicate context like SDOH
  2. a practitioner who recorded the answers
  3. the questions and decimal, string, and coded type answers
    • each question must have a identifier the pointing to question

Profile specific implementation guidance:

  • *The SDC profile (from which this profile is derived) focuses on the constraints appropriate to capturing the “answer(s)” to a FHIR Questionnaire and demands that the Questionnaire’s canonical URL be specified. If the QuestionnaireResponse is based on a non-FHIR form:
    1. Construct a FHIR Questionnaire which represents at least the relevant metadata (in other words, the actual questions may be ommitted).
    2. Communicates the identifier of the non-FHIR form instead of the canonical URI using the US Core Extension Questionnaire URI extension.
  • See the SDOH guidance page for how this profile or alternatively Observations can be used represent SDOH assessments.
  • QuestionnaireResponse can be searched using the standard FHIR RESTful API search parameters. Example searches are shown in the Quick Start section below. Although search chains through the associated Questionnaire can be used to query QuestionnaireResponse by item, individual responses are not directly searchable in QuestionnaireResponse. In order to search directly for ndividual responses, they must be “parsed” into a searchable form - i.e. to a local FHIR or non-FHIR data store such as a database or FHIR Observations.
  • The basic workflow for the creation, discovery and retrieval and data-extraction of FHIR Questionnaire and QuestionnaireResponse is thoroughly documented in the Structured Data Capture (SDC) implementation guide.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from SDCQuestionnaireResponse

Summary

Mandatory: 1 element (1 nested mandatory element)
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element QuestionnaireResponse.meta.tag is sliced based on the value of pattern:$this

This structure is derived from SDCQuestionnaireResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*SDCQuestionnaireResponseUS Core Profile based on SDC QuestionnaireResponse
... meta S0..1MetaMetadata about the resource
.... Slices for tag S0..*CodingTags applied to this resource
Slice: Unordered, Open by pattern:$this
..... tag:All Slices Content/Rules for all slices
...... code 1..1codeSymbol in syntax defined by the system
..... tag:sdoh S0..1CodingSDOH Tag
Binding: US Core Tags ValueSet (required)
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-tags
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: sdoh
... questionnaire S1..1canonical(SDCBaseQuestionnaire)Form being answered
.... us-core-extension-questionnaire-uri S0..1uriThe location where a non-FHIR questionnaire/survey form can be found.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri
... status S1..1codein-progress | completed | amended | entered-in-error | stopped
... subject S1..1Reference(US Core Patient Profile)The subject of the questions
... authored S1..1dateTimeDate the answers were gathered
... author S0..1Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | PractitionerRole | Device | US Core RelatedPerson Profile)Person who received and recorded the answers
... item S0..*BackboneElementGroups and questions
.... linkId S1..1stringPointer to specific item from Questionnaire
.... answer
..... value[x] S0..1Single-valued answer to the question
...... valueBooleanboolean
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueDecimaldecimal S
...... valueIntegerinteger
...... valueStringstring S
...... valueCodingCoding S
...... valueUriuri
...... valueQuantityQuantity
...... valueAttachmentAttachment
...... valueReferenceReference(Any)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse I0..*SDCQuestionnaireResponseUS Core Profile based on SDC QuestionnaireResponse
... id Σ0..1stringLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag SΣ0..*CodingTags applied to this resource
Slice: Unordered, Open by pattern:$this
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


..... tag:All Slices Content/Rules for all slices
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:sdoh SΣ0..1CodingSDOH Tag
Binding: US Core Tags ValueSet (required)

Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-tags
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: sdoh
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... questionnaireresponse-signature 0..*SignatureA signature attesting to the content
URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
... questionnaireresponse-completionMode 0..1CodeableConceptE.g. Verbal, written, electronic
URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode
Binding: QuestionnaireResponseMode (required): Codes indicating how the questionnaire was completed.


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..1IdentifierUnique id for this set of answers
... basedOn Σ0..*Reference(CarePlan | ServiceRequest)Request fulfilled by this QuestionnaireResponse
... partOf Σ0..*Reference(Observation | Procedure)Part of this action
... questionnaire SΣ1..1canonical(SDCBaseQuestionnaire)Form being answered
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... display S0..1stringDisplay name for canonical reference
URL: http://hl7.org/fhir/StructureDefinition/display
.... us-core-extension-questionnaire-uri S0..1uriThe location where a non-FHIR questionnaire/survey form can be found.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri
.... value 0..1stringPrimitive value for canonical
... status ?!SΣ1..1codein-progress | completed | amended | entered-in-error | stopped
Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.

... subject SΣ1..1Reference(US Core Patient Profile)The subject of the questions
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... authored SΣ1..1dateTimeDate the answers were gathered
... author SΣ0..1Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | PractitionerRole | Device | US Core RelatedPerson Profile)Person who received and recorded the answers
... source Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)The person who answered the questions
... item SI0..*BackboneElementGroups and questions
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... sdc-questionnaire-itemMedia 0..1AttachmentMedia to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia
.... questionnaireresponse-signature 0..*SignatureA signature attesting to the content
URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringPointer to specific item from Questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... text S0..1stringName for group or question text
.... answer S0..*BackboneElementThe response(s) to the question
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... sdc-questionnaire-itemAnswerMedia 0..1AttachmentAnswer Media to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia
..... ordinalValue 0..1decimalAssigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/ordinalValue
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] S0..1Single-valued answer to the question
Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.

...... valueBooleanboolean
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueDecimaldecimal S
...... valueIntegerinteger
...... valueStringstring S
...... valueCodingCoding S
...... valueUriuri
...... valueQuantityQuantity
...... valueAttachmentAttachment
...... valueReferenceReference(Any)
..... item S0..*See item (QuestionnaireResponse)Nested groups and questions
.... item S0..*See item (QuestionnaireResponse)Nested questionnaire response items

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse I0..*SDCQuestionnaireResponseUS Core Profile based on SDC QuestionnaireResponse
... meta Σ0..1MetaMetadata about the resource
.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by pattern:$this
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


..... tag:sdoh Σ0..1CodingSDOH Tag
Binding: US Core Tags ValueSet (required)

Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-tags
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: sdoh
... identifier Σ0..1IdentifierUnique id for this set of answers
... questionnaire Σ1..1canonical(SDCBaseQuestionnaire)Form being answered
.... display 0..1stringDisplay name for canonical reference
URL: http://hl7.org/fhir/StructureDefinition/display
.... us-core-extension-questionnaire-uri 0..1uriThe location where a non-FHIR questionnaire/survey form can be found.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri
... status ?!Σ1..1codein-progress | completed | amended | entered-in-error | stopped
Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.

... subject Σ1..1Reference(US Core Patient Profile)The subject of the questions
... authored Σ1..1dateTimeDate the answers were gathered
... author Σ0..1Reference(US Core Practitioner Profile)Person who received and recorded the answers
... item I0..*BackboneElementGroups and questions
.... linkId 1..1stringPointer to specific item from Questionnaire
.... text 0..1stringName for group or question text
.... answer 0..*BackboneElementThe response(s) to the question
..... value[x] 0..1Single-valued answer to the question
Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.

...... valueDecimaldecimal
...... valueStringstring
...... valueCodingCoding
..... item 0..*See item (QuestionnaireResponse)Nested groups and questions
.... item 0..*See item (QuestionnaireResponse)Nested questionnaire response items

doco Documentation for this format

This structure is derived from SDCQuestionnaireResponse

Summary

Mandatory: 1 element (1 nested mandatory element)
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element QuestionnaireResponse.meta.tag is sliced based on the value of pattern:$this

Differential View

This structure is derived from SDCQuestionnaireResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*SDCQuestionnaireResponseUS Core Profile based on SDC QuestionnaireResponse
... meta S0..1MetaMetadata about the resource
.... Slices for tag S0..*CodingTags applied to this resource
Slice: Unordered, Open by pattern:$this
..... tag:All Slices Content/Rules for all slices
...... code 1..1codeSymbol in syntax defined by the system
..... tag:sdoh S0..1CodingSDOH Tag
Binding: US Core Tags ValueSet (required)
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-tags
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: sdoh
... questionnaire S1..1canonical(SDCBaseQuestionnaire)Form being answered
.... us-core-extension-questionnaire-uri S0..1uriThe location where a non-FHIR questionnaire/survey form can be found.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri
... status S1..1codein-progress | completed | amended | entered-in-error | stopped
... subject S1..1Reference(US Core Patient Profile)The subject of the questions
... authored S1..1dateTimeDate the answers were gathered
... author S0..1Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | PractitionerRole | Device | US Core RelatedPerson Profile)Person who received and recorded the answers
... item S0..*BackboneElementGroups and questions
.... linkId S1..1stringPointer to specific item from Questionnaire
.... answer
..... value[x] S0..1Single-valued answer to the question
...... valueBooleanboolean
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueDecimaldecimal S
...... valueIntegerinteger
...... valueStringstring S
...... valueCodingCoding S
...... valueUriuri
...... valueQuantityQuantity
...... valueAttachmentAttachment
...... valueReferenceReference(Any)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse I0..*SDCQuestionnaireResponseUS Core Profile based on SDC QuestionnaireResponse
... id Σ0..1stringLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag SΣ0..*CodingTags applied to this resource
Slice: Unordered, Open by pattern:$this
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


..... tag:All Slices Content/Rules for all slices
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:sdoh SΣ0..1CodingSDOH Tag
Binding: US Core Tags ValueSet (required)

Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-tags
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: sdoh
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... questionnaireresponse-signature 0..*SignatureA signature attesting to the content
URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
... questionnaireresponse-completionMode 0..1CodeableConceptE.g. Verbal, written, electronic
URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode
Binding: QuestionnaireResponseMode (required): Codes indicating how the questionnaire was completed.


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..1IdentifierUnique id for this set of answers
... basedOn Σ0..*Reference(CarePlan | ServiceRequest)Request fulfilled by this QuestionnaireResponse
... partOf Σ0..*Reference(Observation | Procedure)Part of this action
... questionnaire SΣ1..1canonical(SDCBaseQuestionnaire)Form being answered
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... display S0..1stringDisplay name for canonical reference
URL: http://hl7.org/fhir/StructureDefinition/display
.... us-core-extension-questionnaire-uri S0..1uriThe location where a non-FHIR questionnaire/survey form can be found.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri
.... value 0..1stringPrimitive value for canonical
... status ?!SΣ1..1codein-progress | completed | amended | entered-in-error | stopped
Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.

... subject SΣ1..1Reference(US Core Patient Profile)The subject of the questions
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... authored SΣ1..1dateTimeDate the answers were gathered
... author SΣ0..1Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | PractitionerRole | Device | US Core RelatedPerson Profile)Person who received and recorded the answers
... source Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)The person who answered the questions
... item SI0..*BackboneElementGroups and questions
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... sdc-questionnaire-itemMedia 0..1AttachmentMedia to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia
.... questionnaireresponse-signature 0..*SignatureA signature attesting to the content
URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringPointer to specific item from Questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... text S0..1stringName for group or question text
.... answer S0..*BackboneElementThe response(s) to the question
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... sdc-questionnaire-itemAnswerMedia 0..1AttachmentAnswer Media to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia
..... ordinalValue 0..1decimalAssigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/ordinalValue
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] S0..1Single-valued answer to the question
Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.

...... valueBooleanboolean
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueDecimaldecimal S
...... valueIntegerinteger
...... valueStringstring S
...... valueCodingCoding S
...... valueUriuri
...... valueQuantityQuantity
...... valueAttachmentAttachment
...... valueReferenceReference(Any)
..... item S0..*See item (QuestionnaireResponse)Nested groups and questions
.... item S0..*See item (QuestionnaireResponse)Nested questionnaire response items

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
QuestionnaireResponse.meta.securityextensibleAll Security Labels
QuestionnaireResponse.meta.tagexampleCommonTags
QuestionnaireResponse.meta.tag:sdohrequiredPattern: sdoh
QuestionnaireResponse.languagepreferredCommonLanguages
Max Binding: AllLanguages
QuestionnaireResponse.statusrequiredQuestionnaireResponseStatus
QuestionnaireResponse.item.answer.value[x]exampleQuestionnaireAnswerCodes

Notes:

Quick Start

Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile’s information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

  • The syntax used to describe the interactions is described here.
  • See the General Requirements section for additional rules and expectations when a server requires status parameters.
  • See the General Guidance section for additional guidance on searching for multiple patients.

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support fetching a QuestionnaireResponse using the _id search parameter:

    GET [base]/QuestionnaireResponse[id]

    Example:

    1. GET [base]/QuestionnaireResponse/AHC-HRSN-screening-example
    2. GET [base]/QuestionnaireResponse/?_id=AHC-HRSN-screening-example

    Implementation Notes: (how to search by the logical id of the resource)

  2. SHALL support searching for all questionnaireresponses for a patient using the patient search parameter:

    GET [base]/QuestionnaireResponse?patient={Type/}[id]

    Example:

    1. GET [base]/QuestionnaireResponse?patient=1032702

    Implementation Notes: Fetches a bundle of all QuestionnaireResponse resources for the specified patient (how to search by reference)

Optional Search Parameters:

The following search parameter combinations SHOULD be supported:

  1. SHOULD support searching using the combination of the patient and status search parameters:
    • including support for OR search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/QuestionnaireResponse?patient={Type/}[id]&status={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/QuestionnaireResponse?patient=1137192&status=completed

    Implementation Notes: Fetches a bundle of all QuestionnaireResponse resources for the specified patient and status (how to search by reference and how to search by token)

  2. SHOULD support searching using the combination of the patient and _tag search parameters:

    GET [base]/QuestionnaireResponse?patient={Type/}[id]&_tag=sdoh

    Example:

    1. GET [base]/QuestionnaireResponse?patient=1137192&_tag=sdoh

    Implementation Notes: Fetches a bundle of all QuestionnaireResponse resources for the specified patient and _tag= 'sdoh' (how to search by reference and how to search by token)

  3. SHOULD support searching using the combination of the patient and authored search parameters:
    • including support for these authored comparators: gt,lt,ge,le
    • including optional support for AND search on authored (e.g.authored=[date]&authored=[date]]&...)

    GET [base]/QuestionnaireResponse?patient={Type/}[id]&authored={gt|lt|ge|le}[date]{&authored={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/QuestionnaireResponse?patient=113192&date=ge2021

    Implementation Notes: Fetches a bundle of all QuestionnaireResponse resources for the specified patient and date (how to search by reference and how to search by date)

  4. SHOULD support searching using the combination of the patient and _tag and authored search parameters:
    • including support for these authored comparators: gt,lt,ge,le
    • including optional support for AND search on authored (e.g.authored=[date]&authored=[date]]&...)

    GET [base]/QuestionnaireResponse?patient={Type/}[id]&_tag=sdoh&authored={gt|lt|ge|le}[date]{&authored={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/QuestionnaireResponse?patient=113192&date=ge2021&_tag=sdoh

    Implementation Notes: Fetches a bundle of all QuestionnaireResponse resources tagged as 'sdoh' for the specified patient and date (how to search by reference and how to search by token and how to search by date)

  5. SHOULD support searching using the combination of the patient and questionnaire search parameters:

    GET [base]/QuestionnaireResponse?patient={Type/}[id]&questionnaire={Type/}[id]

    Example:

    1. GET [base]/QuestionnaireResponse?patient=113192&questionnaire=http://hl7.org/fhir/us/sdoh-clinicalcare/Questionnaire/SDOHCC-QuestionnaireHungerVitalSign

    Implementation Notes: Fetches a bundle of all QuestionnaireResponse resources for the specified patient that have been completed against a specified form. (how to search by reference)