The Specimen resource represents the specimen that requires a Diagnostic Data Service to be performed.
Name | Card. | Type | Description & Constraints |
---|---|---|---|
Specimen | Specimen | Sample for analysis | |
id | 0..1 | Id | Logical id of this artifact |
meta | 0..1 | Meta | Metadata about the resource |
implicitRules | 0..1 | Uri | A set of rules under which this content was created |
language | 0..1 | Code | Language of the resource content Binding A human language. (http://tools.ietf.org/html/bcp47) Binding Strength Required |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources |
identifier | 1..1 | Identifier | External Identifier |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
use | 0..1 | Code | usual | official | temp | secondary (If known) Binding Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use) Binding Strength Required Example Value official |
type | 0..1 | CodeableConcept | Description of identifier Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type) Binding Strength Extensible |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
coding | 0..1 | Coding | Code defined by a terminology system |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
system | 1..1 | Uri | Identity of the terminology system |
version | 0..1 | String | Version of the system - if relevant |
code | 1..1 | Code | Symbol in syntax defined by the system |
display | 1..1 | String | Representation defined by the system |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
system | 1..1 | Uri | The namespace for the identifier Example Value http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | 1..1 | String | The value that is unique Example Value B603CEDE-8C3F-4909-9CB1-D47C0FDE9F8A |
period | 0..1 | Period | Time period when id is/was valid for use |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
start | 1..1 | DateTime | Starting time with inclusive boundary |
end | 0..1 | DateTime | End time with inclusive boundary, if not ongoing |
assigner | 0..1 | Reference (Organization) | Organization that issued id (may be just text) |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
reference | 1..1 | String | Relative URL reference Example Value Organisation/78D64BB3-B5B2-450B-AEB7-D9035EBC711D |
display | 0..1 | String | Text alternative for the resource Example Value MGP Medical Centre |
status | 0..1 | Code | available | unavailable | unsatisfactory | entered-in-error Binding Codes providing the status/availability of a specimen. (http://hl7.org/fhir/ValueSet/specimen-status) Binding Strength Required |
type | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding The type of the specimen. (http://snomed.info/sct) Binding Strength Example |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
coding | 0..1 | Coding | Code defined by a terminology system |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
system | 1..1 | Uri | Identity of the terminology system Fixed Value http://snomed.info/sct |
version | 0..1 | String | Version of the system - if relevant Example Value 20150731 |
code | 1..1 | Code | Symbol in syntax defined by the system Example Value 119297000 |
display | 1..1 | String | Representation defined by the system Example Value Blood specimen |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
parent | 0..* | Reference (Specimen) | Specimen from which this specimen originated |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
reference | 1..1 | String | Relative, internal or absolute URL reference |
display | 0..1 | String | Text alternative for the resource |
subject | 1..1 | Reference (CareConnect-Patient-1) | Where the specimen came from. This may be from the patient(s) or from the environment or a device |
accessionIdentifier | 0..1 | Identifier | Identifier assigned by the lab |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
use | 0..1 | Code | usual | official | temp | secondary (If known) Binding Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use) Binding Strength Required |
type | 0..1 | CodeableConcept | Description of identifier Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type) Binding Strength Extensible |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
coding | 0..1 | Coding | Code defined by a terminology system |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
system | 1..1 | Uri | Identity of the terminology system |
version | 0..1 | String | Version of the system - if relevant |
code | 1..1 | Code | Symbol in syntax defined by the system |
display | 1..1 | String | Representation defined by the system |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
system | 1..1 | Uri | The namespace for the identifier Example Value http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | 1..1 | String | The value that is unique Example Value ECC4D353 |
period | 0..1 | Period | Time period when id is/was valid for use |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
start | 1..1 | DateTime | Starting time with inclusive boundary |
end | 0..1 | DateTime | End time with inclusive boundary, if not ongoing |
assigner | 0..1 | Reference (Organization) | Organization that issued id (may be just text) |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
reference | 1..1 | String | Relative, internal or absolute URL reference |
display | 0..1 | String | Text alternative for the resource |
receivedTime | 0..1 | DateTime | The time when specimen was received for processing |
collection | 0..1 | BackboneElement | Collection details |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
collector | 0..1 | Reference (CareConnect-Practitioner-1) | Who collected the specimen |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
reference | 1..1 | String | Relative URL reference Example Value Practitioner/4BFCA0EF-85D0-4C5E-B662-D4910BB83D82 |
display | 0..1 | String | Text alternative for the resource |
comment | 0..* | String | Collector comments |
collected[x] | 0..1 | DateTime | Period | Collection time |
quantity (Quantity) | 0..1 | SimpleQuantity | The quantity of specimen collected |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
value (Quantity) | 1..1 | Decimal | Numerical value (with implicit precision) Example Value 6 |
unit (Measurement unit) | 1..1 | String | Unit representation Example Value mL |
system | 1..1 | Uri | System that defines coded unit form Example Value http://unitsofmeasure.org |
code | 0..1 | Code | Coded form of the unit |
method | 0..1 | CodeableConcept | Technique used to perform collection Binding The technique that is used to perform the procedure (http://snomed.info/sct) Binding Strength Example |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
coding | 0..1 | Coding | Code defined by a terminology system |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
system | 1..1 | Uri | Identity of the terminology system Fixed Value http://snomed.info/sct |
version | 0..1 | String | Version of the system - if relevant |
code | 1..1 | Code | Symbol in syntax defined by the system Example Value 32564009 |
display | 1..1 | String | Representation defined by the system Example Value arterial specimen collection for laboratory test |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding Codes describing anatomical locations. May include laterality. (http://snomed.info/sct) Binding Strength Example |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
coding | 0..1 | Coding | Code defined by a terminology system |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
system | 1..1 | Uri | Identity of the terminology system Fixed Value http://snomed.info/sct |
version | 0..1 | String | Version of the system - if relevant |
code | 1..1 | Code | Symbol in syntax defined by the system Example Value 53120007 |
display | 1..1 | String | Representation defined by the system Example Value Arm |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
treatment | 0..* | BackboneElement | Treatment and processing step details |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
description | 0..1 | String | Textual description of procedure Example Value Treated with anticoagulants. |
procedure | 0..1 | CodeableConcept | Indicates the treatment or processing step applied to the specimen Binding Type indicating the technique used to process the specimen (http://hl7.org/fhir/ValueSet/specimen-treatment-procedure) Binding Strength Example |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
coding | 0..1 | Coding | Code defined by a terminology system |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
system | 1..1 | Uri | Identity of the terminology system |
version | 0..1 | String | Version of the system - if relevant |
code | 1..1 | Code | Symbol in syntax defined by the system |
display | 1..1 | String | Representation defined by the system |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
additive | 0..* | Reference (dds-report-substance-1) | Material used in the processing step |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
reference | 0..1 | String | Relative, internal or absolute URL reference |
display | 0..1 | String | Text alternative for the resource |
container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
identifier | 0..1 | Identifier | Id for the container |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
use | 0..1 | Code | usual | official | temp | secondary (If known) Binding Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use) Binding Strength Required |
type | 0..1 | CodeableConcept | Description of identifier Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type) Binding Strength Extensible |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
coding | 0..1 | Coding | Code defined by a terminology system |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
system | 1..1 | Uri | Identity of the terminology system |
version | 0..1 | String | Version of the system - if relevant |
code | 1..1 | Code | Symbol in syntax defined by the system |
display | 1..1 | String | Representation defined by the system |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
system | 1..1 | Uri | The namespace for the identifier Example Value http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | 1..1 | String | The value that is unique Example Value 08FC96C4-EB3A-46D3-93C5-4B23792DCC1C |
period | 0..1 | Period | Time period when id is/was valid for use |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
start | 1..1 | DateTime | Starting time with inclusive boundary |
end | 0..1 | DateTime | End time with inclusive boundary, if not ongoing |
assigner | 0..1 | Reference (CareConnect-Organization-1) | Organization that issued id (may be just text) |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
reference | 1..1 | String | Relative URL reference Example Value Organization/78D64BB3-B5B2-450B-AEB7-D9035EBC711D |
display | 0..1 | String | Text alternative for the resource |
description | 0..1 | String | Textual description of the container |
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding Type of specimen container (http://snomed.info/sct) Binding Strength Example |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
coding | 0..1 | Coding | Code defined by a terminology system |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
system | 1..1 | Uri | Identity of the terminology system Fixed Value http://snomed.info/sct |
version | 0..1 | String | Version of the system - if relevant Example Value 20150731 |
code | 1..1 | Code | Symbol in syntax defined by the system Example Value 434746001 |
display | 1..1 | String | Representation defined by the system Example Value Specimen vial |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
capacity (SimpleQuantity) | 0..1 | SimpleQuantity | Container volume or size |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
value | 1..1 | Decimal | Numerical value (with implicit precision) Example Value 10 |
unit | 1..1 | String | Unit representation Example Value mL |
system | 1..1 | Uri | System that defines coded unit form Example Value http://unitsofmeasure.org |
code | 0..1 | Code | Coded form of the unit |
specimenQuantity (SimpleQuantity) | 0..1 | SimpleQuantity | Quantity of specimen within container |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
value | 1..1 | Decimal | Numerical value (with implicit precision) Example Value 3 |
unit | 1..1 | String | Unit representation Example Value mL |
system | 1..1 | Uri | System that defines coded unit form Example Value http://unitsofmeasure.org |
code | 0..1 | Code | Coded form of the unit |
additiveReference | 0..1 | Reference (Substance) | Additive associated with container Binding Substance added to specimen container (http://hl7.org/fhir/ValueSet/v2-0371) Binding Strength Example |
Path | Name | Binding Strength | ValueSet |
---|---|---|---|
Specimen.language | language | Required | http://tools.ietf.org/html/bcp47 |
Specimen.identifier.use | use | Required | http://hl7.org/fhir/ValueSet/identifier-use |
Specimen.identifier.type | type | Extensible | http://hl7.org/fhir/ValueSet/identifier-type |
Specimen.status | status | Required | http://hl7.org/fhir/ValueSet/specimen-status |
Specimen.type | type | Example | http://snomed.info/sct |
Specimen.collection.method | method | Example | http://snomed.info/sct |
Specimen.collection.bodySite | bodySite | Example | http://snomed.info/sct |
Specimen.treatment.procedure | procedure | Example | http://hl7.org/fhir/ValueSet/specimen-treatment-procedure |
Specimen.container.additiveReference | additiveReference | Example | http://hl7.org/fhir/ValueSet/v2-0371 |