Release 5 FHIR CI-Build

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

10.8.15 10.6.14 Resource Specimen - Search Parameters

Maturity Level : N/A
Responsible Owner: Orders and Observations icon Work Group   Trial Use Normative Security Category : Patient Compartments : Device , Group , 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 http://hl7.org/fhir/SearchParameter/Specimen-bodysite

10.8.16 Generated Narrative: SearchParameter Specimen-bodysite

10.6.15 accession bodysite

Parameter accession bodysite : token reference

The accession number associated with the specimen Reference to a resource (by instance)

Resource Specimen
Expression Specimen.accessionIdentifier 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-bodysite http://hl7.org/fhir/SearchParameter/Specimen-collected

10.8.17 Generated Narrative: SearchParameter Specimen-collected

10.6.16 bodysite collected

Parameter bodysite collected : reference date

Reference to a resource (by instance) The date the specimen was collected

Resource Specimen
Expression Specimen.collection.bodySite.reference Specimen.collection.collected.ofType(dateTime) | Specimen.collection.collected.ofType(Period)
Processing Mode Normal
Target Resources Multiples BodyStructure
  • 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
Multiples Comparators The parameter cannot repeat or have multiple values Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Specimen-collected http://hl7.org/fhir/SearchParameter/Specimen-collection-device-code

10.8.18 Generated Narrative: SearchParameter Specimen-collection-device-code

10.6.17 collected collection-device-code

Parameter collected collection-device-code : date token

The date code associated with the specimen was collected collection device

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

10.8.19 Generated Narrative: SearchParameter Specimen-collector

10.6.18 collector

Parameter collector : reference

Who collected the specimen

Resource Specimen
Expression Specimen.collection.collector
Processing Mode Normal
Target Resources Organization , 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 http://hl7.org/fhir/SearchParameter/Specimen-container-device-code

10.8.20 Generated Narrative: SearchParameter Specimen-container-device-code

10.6.19 container-device container-device-code

Parameter container-device container-device-code : reference token

The unique identifier code associated with the specimen container

Resource Specimen
Expression Specimen.container.device.where(resolve() is Device) Specimen.container.device.ofType(CodeableConcept)
Processing Mode Normal
Target Resources Multiples 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

10.8.21 Generated Narrative: SearchParameter clinical-identifier

10.6.20 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

10.8.22 Generated Narrative: SearchParameter Specimen-parent

10.6.21 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

10.8.23 Generated Narrative: SearchParameter clinical-patient

10.6.22 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

10.8.24 Generated Narrative: SearchParameter Specimen-procedure

10.6.23 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-processing-device-code

Generated Narrative: SearchParameter Specimen-processing-device-code

10.6.24 processing-device-code

Parameter processing-device-code : token

The code associated with the processing device

Resource Specimen
Expression Specimen.processing.device.ofType(CodeableConcept)
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-request

Generated Narrative: SearchParameter Specimen-request

10.6.25 request

Parameter request : reference

The request/order associated with the specimen

Resource Specimen
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

10.8.25 Generated Narrative: SearchParameter Specimen-status

10.6.26 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

10.8.26 Generated Narrative: SearchParameter Specimen-subject

10.6.27 subject

Parameter subject : reference

The subject of the specimen

Resource Specimen
Expression Specimen.subject
Processing Mode Normal
Target Resources Device , NutritionProduct , 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

10.8.27 Generated Narrative: SearchParameter clinical-type

10.6.28 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