Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.
Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Specimen-1 | Version: 0.1.0 | |||
Draft as of 2019-06-19 | Computable Name: CareConnect-Specimen-1 | |||
Copyright/Legal: Copyright © 2019 HL7 UK Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html |
Specimen
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Specimen
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
identifier | ||||
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
accessionIdentifier | ||||
assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
type | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..* | Coding | Code defined by a terminology system Binding: Care Connect Specimen Type (extensible): A code from the SNOMED Clinical Terminology UK | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
version | 0..0 | |||
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
subject | 1..1 | Reference(Group | Device | Substance | CareConnectPatient1) | Where the specimen came from. This may be from the patient(s) or from the environment or a device | |
parent | 0..* | Reference(CareConnect-Specimen-1) | Specimen from which this specimen originated | |
request | 0..* | Reference(CareConnect-ProcedureRequest-1) | Why the specimen was collected | |
collection | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
fastingStatus | 0..1 | CodeableConcept, Duration | A coded value of the fasting status when the specimen was collected. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-FastingStatus-1 Binding: hl7VS-relevantClincialInformation (extensible): v2 Relevant Clincial Information | |
collector | 0..1 | Reference(CareConnect-Practitioner-1) | Who collected the specimen | |
bodySite | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..1 | Coding | Code defined by a terminology system Binding: Care Connect Specimen Body Site (extensible): A code from the SNOMED Clinical Terminology UK | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
version | 0..0 | |||
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
container | ||||
identifier | ||||
assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
note | 0..1 | Annotation | Comments | |
author[x] | 0..1 | Individual responsible for the annotation | ||
authorString | string | |||
authorReference | Reference(CareConnect-Practitioner-1 | CareConnectPatient1) | |||
Documentation for this format |
Path | Conformance | ValueSet |
Specimen.type.coding:snomedCT | extensible | Care Connect Specimen Type |
Specimen.collection.bodySite.coding:snomedCT | extensible | Care Connect Specimen Body Site |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
subject | Σ | 1..1 | Reference(Group | Device | Substance | CareConnectPatient1) | Where the specimen came from. This may be from the patient(s) or from the environment or a device |
parent | 0..* | Reference(CareConnect-Specimen-1) | Specimen from which this specimen originated | |
request | 0..* | Reference(CareConnect-ProcedureRequest-1) | Why the specimen was collected | |
note | 0..1 | Annotation | Comments | |
author[x] | Σ | 0..1 | Individual responsible for the annotation | |
authorString | string | |||
authorReference | Reference(CareConnect-Practitioner-1 | CareConnectPatient1) | |||
text | 1..1 | string | The annotation - text content | |
Documentation for this format |
Path | Conformance | ValueSet |
Specimen.status | required | SpecimenStatus |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
dom-4 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Specimen | 0..* | 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: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Identifier | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
type | Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: v2 Specimen Type (example): The type of the specimen. | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..* | Coding | Code defined by a terminology system Binding: Care Connect Specimen Type (extensible): A code from the SNOMED Clinical Terminology UK | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
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 | ||||
subject | Σ | 1..1 | Reference(Group | Device | Substance | CareConnectPatient1) | Where the specimen came from. This may be from the patient(s) or from the environment or a device | ||||
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
parent | 0..* | Reference(CareConnect-Specimen-1) | Specimen from which this specimen originated | |||||
request | 0..* | Reference(CareConnect-ProcedureRequest-1) | Why the specimen was collected | |||||
collection | 0..1 | BackboneElement | Collection details | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
fastingStatus | 0..1 | CodeableConcept, Duration | A coded value of the fasting status when the specimen was collected. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-FastingStatus-1 Binding: hl7VS-relevantClincialInformation (extensible): v2 Relevant Clincial Information | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
collector | Σ | 0..1 | Reference(CareConnect-Practitioner-1) | Who collected the specimen | ||||
collected[x] | Σ | 0..1 | Collection time | |||||
collectedDateTime | dateTime | |||||||
collectedPeriod | Period | |||||||
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |||||
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIR Specimen Collection Method (example): The technique that is used to perform the procedure | |||||
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMED CT Body Structures (example): Codes describing anatomical locations. May include laterality. | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system Binding: Care Connect Specimen Body Site (extensible): A code from the SNOMED Clinical Terminology UK | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
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 | ||||
processing | 0..* | BackboneElement | Processing and processing step details | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
description | 0..1 | string | Textual description of procedure | |||||
procedure | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen | |||||
additive | 0..* | Reference(Substance) | Material used in the processing step | |||||
time[x] | 0..1 | Date and time of specimen processing | ||||||
timeDateTime | dateTime | |||||||
timePeriod | Period | |||||||
container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Id for the container | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
description | 0..1 | string | Textual description of the container | |||||
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainer (example): Type of specimen container | |||||
capacity | 0..1 | SimpleQuantity | Container volume or size | |||||
specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |||||
additive[x] | 0..1 | Additive associated with container Binding: v2 Additive/Preservative (example): Substance added to specimen container | ||||||
additiveCodeableConcept | CodeableConcept | |||||||
additiveReference | Reference(Substance) | |||||||
note | 0..1 | Annotation | Comments | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorString | string | |||||||
authorReference | Reference(CareConnect-Practitioner-1 | CareConnectPatient1) | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | 1..1 | string | The annotation - text content | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Specimen.language | extensible | Common Languages
| ||||
Specimen.identifier.use | required | IdentifierUse | ||||
Specimen.identifier.type | extensible | Identifier Type Codes | ||||
Specimen.accessionIdentifier.use | required | IdentifierUse | ||||
Specimen.accessionIdentifier.type | extensible | Identifier Type Codes | ||||
Specimen.status | required | SpecimenStatus | ||||
Specimen.type | example | v2 Specimen Type | ||||
Specimen.type.coding:snomedCT | extensible | Care Connect Specimen Type | ||||
Specimen.collection.method | example | FHIR Specimen Collection Method | ||||
Specimen.collection.bodySite | example | SNOMED CT Body Structures | ||||
Specimen.collection.bodySite.coding:snomedCT | extensible | Care Connect Specimen Body Site | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedure | ||||
Specimen.container.identifier.use | required | IdentifierUse | ||||
Specimen.container.identifier.type | extensible | Identifier Type Codes | ||||
Specimen.container.type | example | SpecimenContainer | ||||
Specimen.container.additive[x] | example | v2 Additive/Preservative |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | Specimen.collection.extension:fastingStatus | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Specimen
Summary
Mandatory: 0 element (8 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Specimen
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
identifier | ||||
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
accessionIdentifier | ||||
assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
type | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..* | Coding | Code defined by a terminology system Binding: Care Connect Specimen Type (extensible): A code from the SNOMED Clinical Terminology UK | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
version | 0..0 | |||
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
subject | 1..1 | Reference(Group | Device | Substance | CareConnectPatient1) | Where the specimen came from. This may be from the patient(s) or from the environment or a device | |
parent | 0..* | Reference(CareConnect-Specimen-1) | Specimen from which this specimen originated | |
request | 0..* | Reference(CareConnect-ProcedureRequest-1) | Why the specimen was collected | |
collection | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
fastingStatus | 0..1 | CodeableConcept, Duration | A coded value of the fasting status when the specimen was collected. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-FastingStatus-1 Binding: hl7VS-relevantClincialInformation (extensible): v2 Relevant Clincial Information | |
collector | 0..1 | Reference(CareConnect-Practitioner-1) | Who collected the specimen | |
bodySite | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..1 | Coding | Code defined by a terminology system Binding: Care Connect Specimen Body Site (extensible): A code from the SNOMED Clinical Terminology UK | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
version | 0..0 | |||
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
container | ||||
identifier | ||||
assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
note | 0..1 | Annotation | Comments | |
author[x] | 0..1 | Individual responsible for the annotation | ||
authorString | string | |||
authorReference | Reference(CareConnect-Practitioner-1 | CareConnectPatient1) | |||
Documentation for this format |
Path | Conformance | ValueSet |
Specimen.type.coding:snomedCT | extensible | Care Connect Specimen Type |
Specimen.collection.bodySite.coding:snomedCT | extensible | Care Connect Specimen Body Site |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
subject | Σ | 1..1 | Reference(Group | Device | Substance | CareConnectPatient1) | Where the specimen came from. This may be from the patient(s) or from the environment or a device |
parent | 0..* | Reference(CareConnect-Specimen-1) | Specimen from which this specimen originated | |
request | 0..* | Reference(CareConnect-ProcedureRequest-1) | Why the specimen was collected | |
note | 0..1 | Annotation | Comments | |
author[x] | Σ | 0..1 | Individual responsible for the annotation | |
authorString | string | |||
authorReference | Reference(CareConnect-Practitioner-1 | CareConnectPatient1) | |||
text | 1..1 | string | The annotation - text content | |
Documentation for this format |
Path | Conformance | ValueSet |
Specimen.status | required | SpecimenStatus |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
dom-4 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Specimen | 0..* | 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: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Identifier | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
type | Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: v2 Specimen Type (example): The type of the specimen. | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..* | Coding | Code defined by a terminology system Binding: Care Connect Specimen Type (extensible): A code from the SNOMED Clinical Terminology UK | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
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 | ||||
subject | Σ | 1..1 | Reference(Group | Device | Substance | CareConnectPatient1) | Where the specimen came from. This may be from the patient(s) or from the environment or a device | ||||
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
parent | 0..* | Reference(CareConnect-Specimen-1) | Specimen from which this specimen originated | |||||
request | 0..* | Reference(CareConnect-ProcedureRequest-1) | Why the specimen was collected | |||||
collection | 0..1 | BackboneElement | Collection details | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
fastingStatus | 0..1 | CodeableConcept, Duration | A coded value of the fasting status when the specimen was collected. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-FastingStatus-1 Binding: hl7VS-relevantClincialInformation (extensible): v2 Relevant Clincial Information | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
collector | Σ | 0..1 | Reference(CareConnect-Practitioner-1) | Who collected the specimen | ||||
collected[x] | Σ | 0..1 | Collection time | |||||
collectedDateTime | dateTime | |||||||
collectedPeriod | Period | |||||||
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |||||
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIR Specimen Collection Method (example): The technique that is used to perform the procedure | |||||
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMED CT Body Structures (example): Codes describing anatomical locations. May include laterality. | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system Binding: Care Connect Specimen Body Site (extensible): A code from the SNOMED Clinical Terminology UK | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
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 | ||||
processing | 0..* | BackboneElement | Processing and processing step details | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
description | 0..1 | string | Textual description of procedure | |||||
procedure | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen | |||||
additive | 0..* | Reference(Substance) | Material used in the processing step | |||||
time[x] | 0..1 | Date and time of specimen processing | ||||||
timeDateTime | dateTime | |||||||
timePeriod | Period | |||||||
container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Id for the container | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
description | 0..1 | string | Textual description of the container | |||||
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainer (example): Type of specimen container | |||||
capacity | 0..1 | SimpleQuantity | Container volume or size | |||||
specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |||||
additive[x] | 0..1 | Additive associated with container Binding: v2 Additive/Preservative (example): Substance added to specimen container | ||||||
additiveCodeableConcept | CodeableConcept | |||||||
additiveReference | Reference(Substance) | |||||||
note | 0..1 | Annotation | Comments | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorString | string | |||||||
authorReference | Reference(CareConnect-Practitioner-1 | CareConnectPatient1) | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | 1..1 | string | The annotation - text content | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Specimen.language | extensible | Common Languages
| ||||
Specimen.identifier.use | required | IdentifierUse | ||||
Specimen.identifier.type | extensible | Identifier Type Codes | ||||
Specimen.accessionIdentifier.use | required | IdentifierUse | ||||
Specimen.accessionIdentifier.type | extensible | Identifier Type Codes | ||||
Specimen.status | required | SpecimenStatus | ||||
Specimen.type | example | v2 Specimen Type | ||||
Specimen.type.coding:snomedCT | extensible | Care Connect Specimen Type | ||||
Specimen.collection.method | example | FHIR Specimen Collection Method | ||||
Specimen.collection.bodySite | example | SNOMED CT Body Structures | ||||
Specimen.collection.bodySite.coding:snomedCT | extensible | Care Connect Specimen Body Site | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedure | ||||
Specimen.container.identifier.use | required | IdentifierUse | ||||
Specimen.container.identifier.type | extensible | Identifier Type Codes | ||||
Specimen.container.type | example | SpecimenContainer | ||||
Specimen.container.additive[x] | example | v2 Additive/Preservative |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | Specimen.collection.extension:fastingStatus | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Specimen
Summary
Mandatory: 0 element (8 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron