Skip to main content

SpecimenDefinition

Trial Use 1 Specialized — Quality & Testing

A kind of specimen with associated set of requirements.

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/SpecimenDefinition
InteractionMethodPath
ReadGET/fhir/R5/SpecimenDefinition/[id]
VreadGET/fhir/R5/SpecimenDefinition/[id]/_history/[vid]
UpdatePUT/fhir/R5/SpecimenDefinition/[id]
PatchPATCH/fhir/R5/SpecimenDefinition/[id]
DeleteDELETE/fhir/R5/SpecimenDefinition/[id]
CreatePOST/fhir/R5/SpecimenDefinition
SearchGET/fhir/R5/SpecimenDefinition?...
HistoryGET/fhir/R5/SpecimenDefinition/[id]/_history
Type-historyGET/fhir/R5/SpecimenDefinition/_history

Top-level elements

ElementType(s)CardinalityDescription
urluri0..1Logical canonical URL to reference this SpecimenDefinition (globally unique)
identifierIdentifier0..1Business identifier
versionstring0..1Business version of the SpecimenDefinition
versionAlgorithm[x]string / Coding0..1How to compare versions
namestring0..1Name for this {{title}} (computer friendly)
titlestring0..1Name for this SpecimenDefinition (Human friendly)
derivedFromCanonicalcanonical0..*Based on FHIR definition of another SpecimenDefinition
derivedFromUriuri0..*Based on external definition
statuscode1..1draft
experimentalboolean0..1If this SpecimenDefinition is not for real usage
subject[x]CodeableConcept / Reference0..1Type of subject for specimen collection
datedateTime0..1Date status first applied
publisherstring0..1The name of the individual or organization that published the SpecimenDefinition
contactContactDetail0..*Contact details for the publisher
descriptionmarkdown0..1Natural language description of the SpecimenDefinition
useContextUsageContext0..*Content intends to support these contexts
jurisdictionCodeableConcept0..*Intended jurisdiction for this SpecimenDefinition (if applicable)
purposemarkdown0..1Why this SpecimenDefinition is defined
copyrightmarkdown0..1Use and/or publishing restrictions
copyrightLabelstring0..1Copyright holder and year(s)
approvalDatedate0..1When SpecimenDefinition was approved by publisher
lastReviewDatedate0..1The date on which the asset content was last reviewed by the publisher
effectivePeriodPeriod0..1The effective date range for the SpecimenDefinition
typeCollectedCodeableConcept0..1Kind of material to collect
patientPreparationCodeableConcept0..*Patient preparation for collection
timeAspectstring0..1Time aspect for collection
collectionCodeableConcept0..*Specimen collection procedure
typeTestedBackboneElement0..*Specimen in container intended for testing by lab

Resource-specific search parameters

ParameterTypeDescription
containertokenThe type of specimen conditioned in container expected by the lab
experimentaltokenNot for genuine usage (true)
identifiertokenExternal identifier for the activity definition
is-derivedtokenPrimary specimen (false) or derived specimen (true)
statustokenThe current status of the activity definition
titlestringThe human-friendly name of the activity definition
typetokenThe type of collected specimen
type-testedtokenThe type of specimen conditioned for testing
urluriThe uri that identifies the activity definition

Reference