FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

2.8.16 Resource Composition - Search Parameters

Structured Documents icon Work GroupMaturity Level: N/A  Trial UseSecurity Category: Not Classified Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

Search parameters for the Composition 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

Generated Narrative: SearchParameter Composition-attester

2.8.17 attester

Parameter attester:reference

Who attested the composition

ResourceComposition
Expression Composition.attester.party
Processing Mode Normal
Target Resources Organization, RelatedPerson, PractitionerRole, Practitioner, Patient
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Composition-author

Generated Narrative: SearchParameter Composition-author

2.8.18 author

Parameter author:reference

Who and/or what authored the composition

ResourceComposition
Expression Composition.author
Processing Mode Normal
Target Resources CareTeam, Device, Organization, RelatedPerson, PractitionerRole, Practitioner, Patient
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Composition-category

Generated Narrative: SearchParameter Composition-category

2.8.19 category

Parameter category:token

Categorization of Composition

ResourceComposition
Expression Composition.category
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-date
This search parameter is part of the common search parameter clinical-date

Generated Narrative: SearchParameter clinical-date

2.8.20 date

Parameter date:date

Composition: Composition editing time

ResourceComposition
Expression Composition.date
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
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

Generated Narrative: SearchParameter clinical-encounter

2.8.21 encounter

Parameter encounter:reference

Composition: Context of the Composition

ResourceComposition
Expression Composition.encounter
Processing Mode Normal
Target Resources Encounter
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Composition-entry

Generated Narrative: SearchParameter Composition-entry

2.8.22 entry

Parameter entry:reference

A reference to data that supports this section

ResourceComposition
Expression Composition.section.entry
Processing Mode Normal
Target Resources All Resources
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Composition-event-code

Generated Narrative: SearchParameter Composition-event-code

2.8.23 event-code

Parameter event-code:token

Main clinical acts documented as codes

ResourceComposition
Expression Composition.event.detail.concept
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Composition-event-reference

Generated Narrative: SearchParameter Composition-event-reference

2.8.24 event-reference

Parameter event-reference:reference

Main clinical acts documented as references

ResourceComposition
Expression Composition.event.detail.reference
Processing Mode Normal
Target Resources All Resources
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-identifier
This search parameter is part of the common search parameter clinical-identifier

Generated Narrative: SearchParameter clinical-identifier

2.8.25 identifier

Parameter identifier:token

Composition: Version-independent identifier for the Composition

ResourceComposition
Expression Composition.identifier
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-patient
This search parameter is part of the common search parameter clinical-patient

Generated Narrative: SearchParameter clinical-patient

2.8.26 patient

Parameter patient:reference

Composition: Who and/or what the composition is about

ResourceComposition
Expression Composition.subject.where(resolve() is Patient)
Processing Mode Normal
Target Resources Patient
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Composition-period

Generated Narrative: SearchParameter Composition-period

2.8.27 period

Parameter period:date

The period covered by the documentation

ResourceComposition
Expression Composition.event.period
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Composition-section

Generated Narrative: SearchParameter Composition-section

2.8.28 section

Parameter section:token

Classification of section (recommended)

ResourceComposition
Expression Composition.section.code
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Composition-section-code-text

Generated Narrative: SearchParameter Composition-section-code-text

2.8.29 section-code-text

Parameter section-code-text:composite

Search on the section narrative of the resource

ResourceComposition
Expression Composition.section
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: The parameter may only have one value (no comma separators)

Comparators

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

Generated Narrative: SearchParameter Composition-section-text

2.8.30 section-text

Parameter section-text:special

Search on the section narrative of the resource

ResourceComposition
Expression Composition.section.text | Composition.section.section.text
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Composition-status

Generated Narrative: SearchParameter Composition-status

2.8.31 status

Parameter status:token

preliminary | final | amended | entered-in-error

ResourceComposition
Expression Composition.status
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Composition-subject

Generated Narrative: SearchParameter Composition-subject

2.8.32 subject

Parameter subject:reference

Who and/or what the composition is about

ResourceComposition
Expression Composition.subject
Processing Mode Normal
Target Resources All Resources
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Composition-title

Generated Narrative: SearchParameter Composition-title

2.8.33 title

Parameter title:string

Human Readable name/title

ResourceComposition
Expression Composition.title
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-type
This search parameter is part of the common search parameter clinical-type

Generated Narrative: SearchParameter clinical-type

2.8.34 type

Parameter type:token

Composition: Kind of composition (LOINC if possible)

ResourceComposition
Expression Composition.type
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Composition-url

Generated Narrative: SearchParameter Composition-url

2.8.35 url

Parameter url:uri

The uri that identifies the activity definition

ResourceComposition
Expression Composition.url
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Composition-version

Generated Narrative: SearchParameter Composition-version

2.8.36 version

Parameter version:token

The business version of the activity definition

ResourceComposition
Expression Composition.version
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true