Composition - FHIR v5.0.0-ballot

Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

2.8.17 Resource Composition - Search Parameters

Structured Documents

Work Group

Maturity Level: N/A

Standards Status: Informative

Security Category: Not Classified

Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

Search Parameter Registry for the composition resource

2.8.18 Search Parameters

Search parameter list for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

http://hl7.org/fhir/SearchParameter/Composition-attester

2.8.19 attester

Parameter attester:reference

Who attested the composition

Resource Composition

Expression Composition.attester.party

Target Resources Practitioner, Organization, Patient, PractitionerRole, RelatedPerson

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Composition-author

2.8.20 author

Parameter author:reference

Who and/or what authored the composition

Resource Composition

Expression Composition.author

Target Resources Practitioner, Organization, Device, Patient, PractitionerRole, RelatedPerson

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Composition-category

2.8.21 category

Parameter category:token

Categorization of Composition

Resource Composition

Expression Composition.category

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Composition-context

2.8.22 context

Parameter context:token

Code(s) that apply to the event being documented

Resource Composition

Expression Composition.event.code

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/Composition-date

2.8.23 date

Parameter date:date

Composition editing time

Resources

Expression Composition.date

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/clinical-encounter

2.8.24 encounter

Parameter encounter:reference

Multiple Resources:

Composition: Context of the Composition
DeviceRequest: Encounter during which request was created
DiagnosticReport: The Encounter when the order was made
Flag: Alert relevant during encounter
List: Context in which list created
NutritionOrder: Return nutrition orders with this encounter identifier
Observation: Encounter related to the observation
Procedure: The Encounter during which this Procedure was created
RiskAssessment: Where was assessment performed?
ServiceRequest: An encounter in which this request is made
VisionPrescription: Return prescriptions with this encounter identifier

Resources Composition DeviceRequest DiagnosticReport Flag List NutritionOrder Observation Procedure RiskAssessment ServiceRequest VisionPrescription

Target Resources Encounter

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Composition-entry

2.8.25 entry

Parameter entry:reference

A reference to data that supports this section

Resource Composition

Expression Composition.section.entry

Target Resources All Resources

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/Composition-identifier

2.8.26 identifier

Parameter identifier:token

Version-independent identifier for the Composition

Resources

Expression Composition.identifier

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/Composition-patient

2.8.27 patient

Parameter patient:reference

Who and/or what the composition is about

Resources

Expression Composition.subject.where(resolve() is Patient)

Usage Normal

Target Resources Patient

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Composition-period

2.8.28 period

Parameter period:date

The period covered by the documentation

Resource Composition

Expression Composition.event.period

Multiples The parameter cannot repeat or have multiple values

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/Composition-related

2.8.29 related

Parameter related:reference

Target of the relationship

Resource Composition

Expression Composition.relatesTo.resourceReference

Target Resources All Resources

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Composition-section

2.8.30 section

Parameter section:token

Classification of section (recommended)

Resource Composition

Expression Composition.section.code

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Composition-section-code-text

2.8.31 section-code-text

Parameter section-code-text:composite

Search on the section narrative of the resource

Resource Composition

Expression Composition.section

Multiples The parameter cannot repeat or have multiple values

Components

http://hl7.org/fhir/SearchParameter/Composition-section section.code

http://hl7.org/fhir/SearchParameter/Composition-section-text section.text

http://hl7.org/fhir/SearchParameter/Composition-section-text

2.8.32 section-text

Parameter section-text:special

Search on the section narrative of the resource

Resource Composition

Expression Composition.section.text | Composition.section.section.text

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Composition-status

2.8.33 status

Parameter status:token

preliminary | final | amended | entered-in-error

Resource Composition

Expression Composition.status

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Composition-subject

2.8.34 subject

Parameter subject:reference

Who and/or what the composition is about

Resource Composition

Expression Composition.subject

Target Resources All Resources

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Composition-title

2.8.35 title

Parameter title:string

Human Readable name/title

Resource Composition

Expression Composition.title

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/Composition-type

2.8.36 type

Parameter type:token

Kind of composition (LOINC if possible)

Resources

Expression Composition.type

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Composition-url

2.8.37 url

Parameter url:uri

The uri that identifies the activity definition

Resource Composition

Expression Composition.url

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Composition-version

2.8.38 version

Parameter version:token

The business version of the activity definition

Resource Composition

Expression Composition.version

Multiples The parameter cannot repeat or have multiple values