R6 Ballot (3rd Draft)

This page is part of the FHIR Specification v6.0.0-ballot3: Release 6 Ballot (3rd Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

10.9.14 Resource Specimen - Search Parameters

Orders and Observations icon Work GroupMaturity Level: N/A  Trial UseSecurity Category: Patient Compartments: Device, Group, Patient, Practitioner

Search parameters for the Specimen 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/Specimen-accession

Generated Narrative: SearchParameter Specimen-accession

10.9.15 accession

Parameter accession:token

The accession number associated with the specimen

ResourceSpecimen
Expression Specimen.accessionIdentifier
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/Specimen-bodysite

Generated Narrative: SearchParameter Specimen-bodysite

10.9.16 bodysite

Parameter bodysite:reference

Reference to a resource (by instance)

ResourceSpecimen
Expression Specimen.collection.bodySite.reference
Processing Mode Normal
Target Resources BodyStructure
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/Specimen-collected

Generated Narrative: SearchParameter Specimen-collected

10.9.17 collected

Parameter collected:date

The date the specimen was collected

ResourceSpecimen
Expression Specimen.collection.collected.ofType(dateTime) | Specimen.collection.collected.ofType(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/Specimen-collector

Generated Narrative: SearchParameter Specimen-collector

10.9.18 collector

Parameter collector:reference

Who collected the specimen

ResourceSpecimen
Expression Specimen.collection.collector
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/Specimen-container-device

Generated Narrative: SearchParameter Specimen-container-device

10.9.19 container-device

Parameter container-device:reference

The unique identifier associated with the specimen container

ResourceSpecimen
Expression Specimen.container.device.where(resolve() is Device)
Processing Mode Normal
Target Resources Device
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/Specimen-container-location

Generated Narrative: SearchParameter Specimen-container-location

10.9.20 container-location

Parameter container-location:reference

The location of the specimen container

ResourceSpecimen
Expression Specimen.container.device.resolve().location
Processing Mode Normal
Target Resources Location
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

10.9.21 identifier

Parameter identifier:token

Specimen: The unique identifier associated with the specimen

ResourceSpecimen
Expression Specimen.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/Specimen-organization

Generated Narrative: SearchParameter Specimen-organization

10.9.22 organization

Parameter organization:reference

The organization where the specimen is located

ResourceSpecimen
Expression Specimen.container.device.resolve().owner
Processing Mode Normal
Target Resources HealthcareService, Organization, CareTeam, Device, 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/Specimen-parent

Generated Narrative: SearchParameter Specimen-parent

10.9.23 parent

Parameter parent:reference

The parent of the specimen

ResourceSpecimen
Expression Specimen.parent
Processing Mode Normal
Target Resources Specimen
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

10.9.24 patient

Parameter patient:reference

Specimen: The patient the specimen comes from

ResourceSpecimen
Expression Specimen.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/Specimen-procedure

Generated Narrative: SearchParameter Specimen-procedure

10.9.25 procedure

Parameter procedure:reference

The procedure that collected the specimen

ResourceSpecimen
Expression Specimen.collection.procedure
Processing Mode Normal
Target Resources Procedure
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/Specimen-request

Generated Narrative: SearchParameter Specimen-request

10.9.26 request

Parameter request:reference

The request/order associated with the specimen

ResourceSpecimen
Expression Specimen.request
Processing Mode Normal
Target Resources ServiceRequest
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/Specimen-status

Generated Narrative: SearchParameter Specimen-status

10.9.27 status

Parameter status:token

available | unavailable | unsatisfactory | entered-in-error

ResourceSpecimen
Expression Specimen.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/Specimen-subject

Generated Narrative: SearchParameter Specimen-subject

10.9.28 subject

Parameter subject:reference

The subject of the specimen

ResourceSpecimen
Expression Specimen.subject
Processing Mode Normal
Target Resources Device, NutritionProduct, Group, BiologicallyDerivedProduct, Substance, Location, 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/clinical-type
This search parameter is part of the common search parameter clinical-type

Generated Narrative: SearchParameter clinical-type

10.9.29 type

Parameter type:token

Specimen: The specimen type

ResourceSpecimen
Expression Specimen.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