R6 Ballot (3rd Draft) (1st Full Ballot)

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

10.9.14 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 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 Resource Specimen 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 10.6.15 bodysite

Parameter bodysite : reference

Reference to a resource (by instance)

Resource Specimen
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 10.6.16 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
  • 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 http://hl7.org/fhir/SearchParameter/Specimen-collection-device-code

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

10.9.18 10.6.17 collector collection-device-code

Parameter collector collection-device-code : reference token

Who collected The code associated with the specimen collection device

Resource Specimen
Expression Specimen.collection.collector Specimen.collection.device.ofType(CodeableConcept)
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 http://hl7.org/fhir/SearchParameter/Specimen-collector

Generated Narrative: SearchParameter Specimen-container-device Specimen-collector

10.9.19 10.6.18 container-device collector

Parameter container-device collector : reference

The unique identifier associated with Who collected the specimen container

Resource Specimen
Expression Specimen.container.device.where(resolve() is Device) Specimen.collection.collector
Processing Mode Normal
Target Resources 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/Specimen-container-location http://hl7.org/fhir/SearchParameter/Specimen-container-device-code

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

10.9.20 10.6.19 container-location container-device-code

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

The location of code associated with the specimen container

Resource Specimen
Expression Specimen.container.device.resolve().location Specimen.container.device.ofType(CodeableConcept)
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 10.6.20 identifier

Parameter identifier : token

Specimen : The unique identifier associated with the specimen

Resource Specimen
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 http://hl7.org/fhir/SearchParameter/Specimen-parent

Generated Narrative: SearchParameter Specimen-organization Specimen-parent

10.9.22 10.6.21 organization parent

Parameter organization parent : reference

The organization where parent of the specimen is located

Resource Specimen
Expression Specimen.container.device.resolve().owner Specimen.parent
Processing Mode Normal
Target Resources HealthcareService , Organization , CareTeam , Device , RelatedPerson , PractitionerRole , Practitioner , Patient 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/Specimen-parent http://hl7.org/fhir/SearchParameter/clinical-patient
This search parameter is part of the common search parameter clinical-patient

Generated Narrative: SearchParameter Specimen-parent clinical-patient

10.9.23 10.6.22 parent patient

Parameter parent patient : reference

Specimen : The parent of patient the specimen comes from

Resource Specimen
Expression Specimen.parent Specimen.subject.where(resolve() is Patient)
Processing Mode Normal
Target Resources Specimen 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-patient http://hl7.org/fhir/SearchParameter/Specimen-procedure This search parameter is part of the common search parameter clinical-patient

Generated Narrative: SearchParameter clinical-patient Specimen-procedure

10.9.24 10.6.23 patient procedure

Parameter patient procedure : reference

Specimen : The patient procedure that collected the specimen comes from

Resource Specimen
Expression Specimen.subject.where(resolve() is Patient) Specimen.collection.procedure
Processing Mode Normal
Target Resources Patient 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-procedure http://hl7.org/fhir/SearchParameter/Specimen-processing-device-code

Generated Narrative: SearchParameter Specimen-procedure Specimen-processing-device-code

10.9.25 10.6.24 procedure processing-device-code

Parameter procedure processing-device-code : reference token

The procedure that collected code associated with the specimen processing device

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

Generated Narrative: SearchParameter Specimen-status

10.9.27 10.6.26 status

Parameter status : token

available | unavailable | unsatisfactory | entered-in-error

Resource Specimen
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 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
  • 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 10.6.28 type

Parameter type : token

Specimen : The specimen type

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