Release 5 R6 Ballot (1st Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . For a full list of available versions, see the Directory of published versions

Orders and Observations icon Work Group Maturity Level : N/A   Trial Use Security Category : Patient Compartments : Device , Patient , Practitioner

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

Parameter accession : token

The accession number associated with the specimen

Resource Specimen
Expression Specimen.accessionIdentifier
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Parameter bodysite : reference

Reference to a resource (by instance)

Resource Specimen
Expression Specimen.collection.bodySite.reference
Processing Mode Normal
Target Resources BodyStructure
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Parameter collected : date

The date the specimen was collected

Resource Specimen
Expression Specimen.collection.collected.ofType(dateTime) | Specimen.collection.collected.ofType(Period)
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Parameter collector : reference

Who collected the specimen

Resource Specimen
Expression Specimen.collection.collector
Processing Mode Normal
Target Resources RelatedPerson , PractitionerRole , Practitioner , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Parameter container-device : reference

The unique identifier associated with the specimen container

Resource Specimen
Expression Specimen.container.device.where(resolve() is Device)
Processing Mode Normal
Target Resources Device
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Parameter identifier : token

Specimen : The unique identifier associated with the specimen

Resource Specimen
Expression Specimen.identifier
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Parameter parent : reference

The parent of the specimen

Resource Specimen
Expression Specimen.parent
Processing Mode Normal
Target Resources Specimen
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Parameter patient : reference

Specimen : The patient the specimen comes from

Resource Specimen
Expression Specimen.subject.where(resolve() is Patient)
Processing Mode Normal
Target Resources Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Parameter procedure : reference

The procedure that collected the specimen

Resource Specimen
Expression Specimen.collection.procedure
Processing Mode Normal
Target Resources Procedure
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Parameter status : token

available | unavailable | unsatisfactory | entered-in-error

Resource Specimen
Expression Specimen.status
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Parameter subject : reference

The subject of the specimen

Resource Specimen
Expression Specimen.subject
Processing Mode Normal
Target Resources Device , Group , BiologicallyDerivedProduct , Substance , Location , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Parameter type : token

Specimen : The specimen type

Resource Specimen
Expression Specimen.type
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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