0.1.0 - ci-build
MatchSyncIG - Local Development build (v0.1.0). See the Directory of published versions
Official URL: http://fhir.nmdp.org/ig/matchsync/StructureDefinition/msspecimen | Version: 0.1.0 | |||
Active as of 2023-05-09 | Computable Name: MSSpecimen |
Patient sample used for HLA typing
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 | |
meta | ||||
Slices for security | 1..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by pattern:system | |
security:TransplantCenter | S | 1..1 | Coding | Security Labels applied to this resource |
system | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.nmdp.org/codesystem/transplant-center | |
code | 1..1 | code | Symbol in syntax defined by the system | |
identifier | S | 1..* | Identifier | External Identifier |
subject | S | 1..1 | Reference(MSPatient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
meta | Σ | 0..1 | Meta | Metadata about the resource |
Slices for security | Σ | 1..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by pattern:system Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:TransplantCenter | SΣ | 1..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.nmdp.org/codesystem/transplant-center |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | External Identifier |
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
subject | SΣ | 1..1 | Reference(MSPatient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
Documentation for this format |
Path | Conformance | ValueSet |
Specimen.meta.security | extensible | All Security Labels |
Specimen.meta.security:TransplantCenter | extensible | All Security Labels |
Specimen.status | required | SpecimenStatus |
Id | Grade | Path(s) | Details | Requirements |
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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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() | |
dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Specimen | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
Slices for security | Σ | 1..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by pattern:system Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:TransplantCenter | SΣ | 1..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.nmdp.org/codesystem/transplant-center | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | SΣ | 1..* | Identifier | External Identifier | ||||
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
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: hl7VS-specimenType (example): The type of the specimen. | ||||
subject | SΣ | 1..1 | Reference(MSPatient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device | ||||
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
parent | 0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||
request | 0..* | Reference(ServiceRequest) | Why the specimen was collected | |||||
collection | 0..1 | BackboneElement | Collection details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||
collected[x] | Σ | 0..1 | Collection time | |||||
collectedDateTime | dateTime | |||||||
collectedPeriod | Period | |||||||
duration | Σ | 0..1 | Duration | How long it took to collect specimen | ||||
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |||||
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
fastingStatus[x] | Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
fastingStatusCodeableConcept | CodeableConcept | |||||||
fastingStatusDuration | Duration | |||||||
processing | 0..* | BackboneElement | Processing and processing step details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
identifier | Σ | 0..* | Identifier | Id for the container | ||||
description | 0..1 | string | Textual description of the container | |||||
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (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: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
additiveCodeableConcept | CodeableConcept | |||||||
additiveReference | Reference(Substance) | |||||||
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
note | 0..* | Annotation | Comments | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Specimen.meta.security | extensible | All Security Labels | ||||
Specimen.meta.security:TransplantCenter | extensible | All Security Labels | ||||
Specimen.meta.tag | example | CommonTags | ||||
Specimen.language | preferred | CommonLanguages
| ||||
Specimen.status | required | SpecimenStatus | ||||
Specimen.type | example | Hl7VSSpecimenType | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethod | ||||
Specimen.collection.bodySite | example | SNOMEDCTBodyStructures | ||||
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformation | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedure | ||||
Specimen.container.type | example | SpecimenContainerType | ||||
Specimen.container.additive[x] | example | Hl7VSAdditivePreservative | ||||
Specimen.condition | extensible | Hl7VSSpecimenCondition |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Specimen
Summary
Mandatory: 2 elements (4 nested mandatory elements)
Must-Support: 3 elements
Structures
This structure refers to these other structures:
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 | |
meta | ||||
Slices for security | 1..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by pattern:system | |
security:TransplantCenter | S | 1..1 | Coding | Security Labels applied to this resource |
system | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.nmdp.org/codesystem/transplant-center | |
code | 1..1 | code | Symbol in syntax defined by the system | |
identifier | S | 1..* | Identifier | External Identifier |
subject | S | 1..1 | Reference(MSPatient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
meta | Σ | 0..1 | Meta | Metadata about the resource |
Slices for security | Σ | 1..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by pattern:system Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:TransplantCenter | SΣ | 1..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.nmdp.org/codesystem/transplant-center |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | External Identifier |
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
subject | SΣ | 1..1 | Reference(MSPatient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
Documentation for this format |
Path | Conformance | ValueSet |
Specimen.meta.security | extensible | All Security Labels |
Specimen.meta.security:TransplantCenter | extensible | All Security Labels |
Specimen.status | required | SpecimenStatus |
Id | Grade | Path(s) | Details | Requirements |
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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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() | |
dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Specimen | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
Slices for security | Σ | 1..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by pattern:system Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:TransplantCenter | SΣ | 1..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.nmdp.org/codesystem/transplant-center | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | SΣ | 1..* | Identifier | External Identifier | ||||
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
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: hl7VS-specimenType (example): The type of the specimen. | ||||
subject | SΣ | 1..1 | Reference(MSPatient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device | ||||
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
parent | 0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||
request | 0..* | Reference(ServiceRequest) | Why the specimen was collected | |||||
collection | 0..1 | BackboneElement | Collection details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||
collected[x] | Σ | 0..1 | Collection time | |||||
collectedDateTime | dateTime | |||||||
collectedPeriod | Period | |||||||
duration | Σ | 0..1 | Duration | How long it took to collect specimen | ||||
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |||||
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
fastingStatus[x] | Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
fastingStatusCodeableConcept | CodeableConcept | |||||||
fastingStatusDuration | Duration | |||||||
processing | 0..* | BackboneElement | Processing and processing step details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
identifier | Σ | 0..* | Identifier | Id for the container | ||||
description | 0..1 | string | Textual description of the container | |||||
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (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: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
additiveCodeableConcept | CodeableConcept | |||||||
additiveReference | Reference(Substance) | |||||||
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
note | 0..* | Annotation | Comments | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Specimen.meta.security | extensible | All Security Labels | ||||
Specimen.meta.security:TransplantCenter | extensible | All Security Labels | ||||
Specimen.meta.tag | example | CommonTags | ||||
Specimen.language | preferred | CommonLanguages
| ||||
Specimen.status | required | SpecimenStatus | ||||
Specimen.type | example | Hl7VSSpecimenType | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethod | ||||
Specimen.collection.bodySite | example | SNOMEDCTBodyStructures | ||||
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformation | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedure | ||||
Specimen.container.type | example | SpecimenContainerType | ||||
Specimen.container.additive[x] | example | Hl7VSAdditivePreservative | ||||
Specimen.condition | extensible | Hl7VSSpecimenCondition |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Specimen
Summary
Mandatory: 2 elements (4 nested mandatory elements)
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron