Composition - FHIR v5.0.0

Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

2.8.17 Resource Composition - Search Parameters

Structured Documents icon

Work Group

Maturity Level: N/A

Trial Use

Security Category: Not Classified

Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

Search parameters for the Resource Composition - Search Parameters resource. Also check the Extensions registry for search parameters on extensions related to 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.18 attester

Parameter attester:reference

Who attested the composition

Resource Composition

Expression Composition.attester.party

Processing Mode Normal

Target Resources Organization, RelatedPerson, PractitionerRole, Practitioner, Patient

Multiples The parameter cannot repeat or have multiple values

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

2.8.19 author

Parameter author:reference

Who and/or what authored the composition

Resource Composition

Expression Composition.author

Processing Mode Normal

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

Multiples The parameter cannot repeat or have multiple values

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

2.8.20 category

Parameter category:token

Categorization of Composition

Resource Composition

Expression Composition.category

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

This search parameter is part of the common search parameter clinical-date

2.8.21 date

Parameter date:date

Composition: Composition editing time

Resource Composition

Expression Composition.date

Processing Mode Normal

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/clinical-encounter

This search parameter is part of the common search parameter clinical-encounter

2.8.22 encounter

Parameter encounter:reference

Composition: Context of the Composition

Resource Composition

Expression Composition.encounter

Processing Mode Normal

Target Resources Encounter

Multiples The parameter cannot repeat or have multiple values

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

2.8.23 entry

Parameter entry:reference

A reference to data that supports this section

Resource Composition

Expression Composition.section.entry

Processing Mode Normal

Target Resources All Resources

Multiples The parameter cannot repeat or have multiple values

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

2.8.24 event-code

Parameter event-code:token

Main clinical acts documented as codes

Resource Composition

Expression Composition.event.detail.concept

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Composition-event-reference

2.8.25 event-reference

Parameter event-reference:reference

Main clinical acts documented as references

Resource Composition

Expression Composition.event.detail.reference

Processing Mode Normal

Target Resources All Resources

Multiples The parameter cannot repeat or have multiple values

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

This search parameter is part of the common search parameter clinical-identifier

2.8.26 identifier

Parameter identifier:token

Composition: Version-independent identifier for the Composition

Resource Composition

Expression Composition.identifier

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

This search parameter is part of the common search parameter clinical-patient

2.8.27 patient

Parameter patient:reference

Composition: Who and/or what the composition is about

Resource Composition

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

Processing Mode 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

Processing Mode Normal

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

Processing Mode Normal

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

Processing Mode Normal

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

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

Components

section section.code

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

Processing Mode Normal

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

Processing Mode Normal

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

Processing Mode Normal

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

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

This search parameter is part of the common search parameter clinical-type

2.8.36 type

Parameter type:token

Composition: Kind of composition (LOINC if possible)

Resource Composition

Expression Composition.type

Processing Mode 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

Processing Mode Normal

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

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values