HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.0.0 - STU 2

This page is part of the electronic Case Reporting (eCR) (v2.0.0: STU 2 on FHIR R4) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

Extension: US Public Health FHIR Query Pattern Extension

Supports communicating the FHIR query for a given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be extended to be able to provide an Endpoint or CapabilityStatement to provide this information. If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used. This is not a resolveable URL, and that it will contain 1) No base canonical (so it’s a relative query), and 2) Parameters using tokens that are denoted using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId

The official URL for this extension is:

http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension

Status: draft
Extension maintained by: HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)

Context of Use

This extension may be used on the following element(s):

  • PlanDefinition.repeat(action).input

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Fixed Value: 1 element

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionUS Public Health FHIR Query Pattern Extension
... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension"
... value[x] 0..1stringValue of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionUS Public Health FHIR Query Pattern Extension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Fixed Value: 1 element

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionUS Public Health FHIR Query Pattern Extension
... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension"
... value[x] 0..1stringValue of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionUS Public Health FHIR Query Pattern Extension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdGradePathDetailsRequirements
ele-1errorExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())