INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
StructureDefinition: CareConnect-Specimen-1
Specimen
The official URL for this profile is:
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Specimen-1
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Specimen-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-ProcedureRequest-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1
Extensions
This structure refers to these extensions:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
- https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-FastingStatus-1
Slices
This structure defines the following Slices:
- The element Specimen.type.coding is sliced based on the value of value:system
- The element Specimen.collection.bodySite.coding is sliced based on the value of value:system
This structure is derived from Specimen
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Specimen | I | 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) Max Binding: All Languages | |
| text | I | 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) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| 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) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| 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) |
| type | Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: v2 Specimen Type (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
 coding | Σ | 0..* | (Slice Definition) | 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) |
  id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 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 | CareConnect-Patient-1) | 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 | I | 0..1 | BackboneElement | Collection details |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-CareConnect-FastingStatus-1 | I | 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: v2 Relevant Clincial Information (extensible) |
| 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) | |
 bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMED CT Body Structures (example) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | 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) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 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 | I | 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) | |
| 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 | I | 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) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| 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) | |
| 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) | ||
| 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 | CareConnect-Patient-1) | |||
| time | Σ | 0..1 | dateTime | When the annotation was made |
| text | 1..1 | string | The annotation - text content | |
| Documentation for this format | ||||
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:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Specimen-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-ProcedureRequest-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1
Extensions
This structure refers to these extensions:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
- https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-FastingStatus-1
Slices
This structure defines the following Slices:
- The element Specimen.type.coding is sliced based on the value of value:system
- The element Specimen.collection.bodySite.coding is sliced based on the value of value:system
Differential View
This structure is derived from Specimen
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Specimen | I | 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) Max Binding: All Languages | |
| text | I | 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) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| 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) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| 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) |
| type | Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: v2 Specimen Type (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | 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) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 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 | CareConnect-Patient-1) | 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 | I | 0..1 | BackboneElement | Collection details |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-CareConnect-FastingStatus-1 | I | 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: v2 Relevant Clincial Information (extensible) |
| 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) | |
| bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMED CT Body Structures (example) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | 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) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 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 | I | 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) | |
| 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 | I | 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) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| 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) | |
| 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) | ||
| 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 | CareConnect-Patient-1) | |||
| time | Σ | 0..1 | dateTime | When the annotation was made |
| text | 1..1 | string | The annotation - text content | |
| Documentation for this format | ||||
Other representations of profile: Schematron
Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| Specimen.language | extensible | Common Languages Max Binding: All 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 |
Constraints
Constraints
| Id | Path | Details | Requirements |
| dom-2 | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Specimen | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | 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() | |
| dom-3 | 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() | |
| ele-1 | Specimen.collection | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Specimen.collection.extension:fastingStatus | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Specimen.collection.extension:fastingStatus | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Specimen.processing | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Specimen.container | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |