HLA Immunoassay Working Sample

Metadata

These are the details for this resource:

You need a license to run FQL queries

Resource content

These are different views on this resource:

This is the tree view:
idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
identifierΣ0..*Identifier
accessionIdentifierΣ0..1Identifier
statusΣ ?!0..1codeBinding
typeΣ0..1CodeableConcept
subjectΣ0..1Reference(Patient | Group | Device | Substance | Location)
receivedTimeΣ0..1dateTime
parent0..*Reference(Specimen)
request0..*Reference(ServiceRequest)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
collectorΣ0..1Reference(Practitioner | PractitionerRole)
collectedDateTimedateTime
collectedPeriodPeriod
durationΣ0..1Duration
quantity0..1SimpleQuantity
method0..1CodeableConcept
bodySite0..1CodeableConcept
fastingStatusCodeableConceptCodeableConcept
fastingStatusDurationDuration
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
description0..1string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriBinding
versionΣ0..1string
codeS Σ1..1codeBinding
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
additive0..*Reference(Substance)
timeDateTimedateTime
timePeriodPeriod
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
identifierΣ0..*Identifier
description0..1string
type0..1CodeableConcept
capacity0..1SimpleQuantity
specimenQuantity0..1SimpleQuantity
additiveCodeableConceptCodeableConcept
additiveReferenceReference(Substance)
conditionΣ0..*CodeableConceptBinding
note0..*Annotation
This is the detailed view:
Specimen
ShortSample for analysis
Definition

A sample to be used for analysis.

Cardinality0..*
Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity. Role, or Act
  • rim: Role[classCode=SPEC]
Specimen.id
ShortLogical id of this artifact
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality0..1
Typestring
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Specimen.meta
ShortMetadata about the resource
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality0..1
TypeMeta
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Specimen.implicitRules
ShortA set of rules under which this content was created
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Specimen.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Specimen.text
ShortText summary of the resource, for human interpretation
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Cardinality0..1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
Specimen.contained
ShortContained, inline Resources
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Cardinality0..*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: N/A
Specimen.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Specimen.modifierExtension
ShortExtensions that cannot be ignored
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Specimen.identifier
ShortExternal Identifier
Definition

Id for specimen.

Cardinality0..*
TypeIdentifier
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: SPM-2
  • rim: .id
Specimen.accessionIdentifier
ShortIdentifier assigned by the lab
Definition

The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.

Cardinality0..1
TypeIdentifier
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: SPM-30 (v2.7+)
  • rim: .participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id
Specimen.status
Shortavailable | unavailable | unsatisfactory | entered-in-error
Definition

The availability of the specimen.

Cardinality0..1
Typecode
Binding

Codes providing the status/availability of a specimen.

SpecimenStatus (required)

ModifierTrue
SummaryTrue
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • v2: SPM-20
  • rim: status
Specimen.type
ShortKind of material that forms the specimen
Definition

The kind of material that forms the specimen.

Cardinality0..1
TypeCodeableConcept
Binding

The type of the specimen.

v2.0487 (example)

SummaryTrue
Comments

The type can change the way that a specimen is handled and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.what[x]
  • v2: SPM-4 and possibly SPM-5
  • rim: .code
Specimen.subject
ShortWhere 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
Definition

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.

Cardinality0..1
TypeReference(Patient | Group | Device | Substance | Location)
SummaryTrue
Requirements

Must know the subject context.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.subject[x]
  • rim: .scoper or .scoper.playsRole
  • w5: FiveWs.subject
Specimen.receivedTime
ShortThe time when specimen was received for processing
Definition

Time when specimen was received for processing or testing.

Cardinality0..1
TypedateTime
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.done[x]
  • v2: SPM-18
  • rim: .participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime
Specimen.parent
ShortSpecimen from which this specimen originated
Definition

Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.

Cardinality0..*
TypeReference(Specimen)
Comments

The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .scoper (if parent) .player.scopesRole[classCode=SPEC].player (if child)
Specimen.request
ShortWhy the specimen was collected
Definition

Details concerning a service request that required a specimen to be collected.

Cardinality0..*
TypeReference(ServiceRequest)
Comments

The request may be explicit or implied such with a ServiceRequest that requires a blood draw.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.why[x]
  • v2: ORC? OBR-2/3?
  • rim: outboundRelationship[typeCode=FLFS].target
Specimen.collection
ShortCollection details
Definition

Details concerning the specimen collection.

Cardinality0..1
TypeBackboneElement
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: SPM-14
  • rim: .participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]
Specimen.collection.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Specimen.collection.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Specimen.collection.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Specimen.collection.collector
ShortWho collected the specimen
Definition

Person who collected the specimen.

Cardinality0..1
TypeReference(Practitioner | PractitionerRole)
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.actor
  • v2: PRT
  • rim: .participation[typeCode=PFM].role
Specimen.collection.collected[x]
ShortCollection time
Definition

Time when specimen was collected from subject - the physiologically relevant time.

Cardinality0..1
TypedateTime, Period
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.init
  • v2: SPM-17
  • rim: .effectiveTime
Specimen.collection.duration
ShortHow long it took to collect specimen
Definition

The span of time over which the collection of a specimen occurred.

Cardinality0..1
TypeDuration
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.init
Specimen.collection.quantity
ShortThe quantity of specimen collected
Definition

The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.

Cardinality0..1
TypeSimpleQuantity
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: SPM-12
  • rim: .participation[typeCode=SBJ].role[classCode=SPEC].player.quantity
Specimen.collection.method
ShortTechnique used to perform collection
Definition

A coded value specifying the technique that is used to perform the procedure.

Cardinality0..1
TypeCodeableConcept
Binding

The technique that is used to perform the procedure.

FHIRSpecimenCollectionMethod (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: SPM-7
  • rim: .methodCode
Specimen.collection.bodySite
ShortAnatomical collection site
Definition

Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.

Cardinality0..1
TypeCodeableConcept
Binding

Codes describing anatomical locations. May include laterality.

SNOMEDCTBodyStructures (example)

Comments

If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension bodySite.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: SPM-8 and SPM-9
  • rim: .targetSiteCode
Specimen.collection.fastingStatus[x]
ShortWhether or how long patient abstained from food and/or drink
Definition

Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.

Cardinality0..1
TypeCodeableConcept, Duration
Binding

Codes describing the fasting status of the patient.

v2.0916 (extensible)

SummaryTrue
Requirements

Many diagnostic tests require fasting to facilitate accurate interpretation.

Comments

Representing fasting status using this element is preferred to representing it with an observation using a 'pre-coordinated code' such as LOINC 2005-7 (Calcium [Moles/​time] in 2 hour Urine --12 hours fasting), or using a component observation such asObservation.component code` = LOINC 49541-6 (Fasting status - Reported).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBR-
Specimen.processing
ShortProcessing and processing step details
Definition

Details concerning processing and processing steps for the specimen.

Cardinality1..*
TypeBackboneElement
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]
Specimen.processing.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Specimen.processing.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Specimen.processing.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Specimen.processing.description
ShortTextual description of procedure
Definition

Textual description of procedure.

Cardinality0..1
Typestring
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .text
Specimen.processing.procedure
ShortIndicates the treatment step applied to the specimen
Definition

A coded value specifying the procedure used to process the specimen.

Cardinality1..1
TypeCodeableConcept
Binding

Type indicating the technique used to process the specimen.

SpecimenProcessingProcedure (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .code
Specimen.processing.procedure.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Specimen.processing.procedure.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Specimen.processing.procedure.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..*
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Specimen.processing.procedure.coding.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Specimen.processing.procedure.coding.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Specimen.processing.procedure.coding.system
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality1..1
Typeuri
Binding

http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes (required)

Must SupportTrue
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Specimen.processing.procedure.coding.version
ShortVersion of the system - if relevant
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Cardinality0..1
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Specimen.processing.procedure.coding.code
ShortSymbol in syntax defined by the system
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality1..1
Typecode
Binding

http://fhir.nmdp.org/terminologyfhir/ValueSet//hla-immuno-assay-sample-treatment (required)

Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Specimen.processing.procedure.coding.display
ShortRepresentation defined by the system
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality0..1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Specimen.processing.procedure.coding.userSelected
ShortIf this coding was chosen directly by the user
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality0..1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Specimen.processing.procedure.text
ShortPlain text representation of the concept
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality0..1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Specimen.processing.additive
ShortMaterial used in the processing step
Definition

Material used in the processing step.

Cardinality0..*
TypeReference(Substance)
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: SPM-6
  • rim: .participation[typeCode=CSM].role[classCode=ADTV].code
Specimen.processing.time[x]
ShortDate and time of specimen processing
Definition

A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.

Cardinality0..1
TypedateTime, Period
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
Specimen.container
ShortDirect container of specimen (tube/slide, etc.)
Definition

The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

Cardinality0..*
TypeBackboneElement
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .player.scopingRole[classCode=CONT].scoper
Specimen.container.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Specimen.container.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Specimen.container.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Specimen.container.identifier
ShortId for the container
Definition

Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.

Cardinality0..*
TypeIdentifier
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: SAC-3
  • rim: .id
Specimen.container.description
ShortTextual description of the container
Definition

Textual description of the container.

Cardinality0..1
Typestring
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .desc
Specimen.container.type
ShortKind of container directly associated with specimen
Definition

The type of container associated with the specimen (e.g. slide, aliquot, etc.).

Cardinality0..1
TypeCodeableConcept
Binding

Type of specimen container.

SpecimenContainerType (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: SPM-27
  • rim: .code
Specimen.container.capacity
ShortContainer volume or size
Definition

The capacity (volume or other measure) the container may contain.

Cardinality0..1
TypeSimpleQuantity
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20
  • rim: .quantity
Specimen.container.specimenQuantity
ShortQuantity of specimen within container
Definition

The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.

Cardinality0..1
TypeSimpleQuantity
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: SAC-23 (value) SAC-24 (units
  • rim: .playedRole[classCode=CONT].quantity
Specimen.container.additive[x]
ShortAdditive associated with container
Definition

Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.

Cardinality0..1
TypeCodeableConcept, Reference(Substance)
Binding

Substance added to specimen container.

v2.0371 (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: SAC-27
  • rim: .scopesRole[classCode=ADTV].player
Specimen.condition
ShortState of the specimen
Definition

A mode or state of being that describes the nature of the specimen.

Cardinality0..*
TypeCodeableConcept
Binding

Codes describing the state of the specimen.

v2.0493 (extensible)

SummaryTrue
Requirements

The specimen condition can be used to assess its quality or appropriateness for a specific test.

Comments

Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: SPM-24
Specimen.note
ShortComments
Definition

To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

Cardinality0..*
TypeAnnotation
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX
  • rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value
This is the resource in XML:
<StructureDefinition xmlns="http://hl7.org/fhir">
<url value="https://fhir.nmdp.org/ig/HlaAntibodyReport/StructureDefinition/hla-immuno-assay-working-sample" />
<version value="0.1.0" />
<name value="HLAImmunoAssayWorkingSample" />
<title value="HLA Immunoassay Working Sample" />
<status value="draft" />
<publisher value="NMDP" />
<name value="David Wroe" />
<system value="email" />
<value value="dwroe@nmdp.org" />
<use value="work" />
</telecom>
</contact>
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Specimen" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Specimen" />
<derivation value="constraint" />
<element id="Specimen.processing">
<path value="Specimen.processing" />
<min value="1" />
</element>
<element id="Specimen.processing.procedure">
<path value="Specimen.processing.procedure" />
<min value="1" />
</element>
<element id="Specimen.processing.procedure.coding.system">
<path value="Specimen.processing.procedure.coding.system" />
<min value="1" />
<mustSupport value="true" />
<strength value="required" />
<valueSet value="http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes" />
</binding>
</element>
<element id="Specimen.processing.procedure.coding.code">
<path value="Specimen.processing.procedure.coding.code" />
<min value="1" />
<mustSupport value="true" />
<strength value="required" />
<valueSet value="http://fhir.nmdp.org/terminologyfhir/ValueSet//hla-immuno-assay-sample-treatment" />
</binding>
</element>
</differential>
</StructureDefinition>
This is the resource in JSON:
{
"resourceType": "StructureDefinition",
"url": "https://fhir.nmdp.org/ig/HlaAntibodyReport/StructureDefinition/hla-immuno-assay-working-sample",
"version": "0.1.0",
"name": "HLAImmunoAssayWorkingSample",
"title": "HLA Immunoassay Working Sample",
"status": "draft",
"publisher": "NMDP",
"contact": [
{
"name": "David Wroe",
"telecom": [
{
"system": "email",
"value": "dwroe@nmdp.org",
"use": "work"
}
]
}
],
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Specimen",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Specimen",
"derivation": "constraint",
"element": [
{
"id": "Specimen.processing",
"path": "Specimen.processing",
"min": 1
},
{
"id": "Specimen.processing.procedure",
"path": "Specimen.processing.procedure",
"min": 1
},
{
"id": "Specimen.processing.procedure.coding.system",
"path": "Specimen.processing.procedure.coding.system",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes"
}
},
{
"id": "Specimen.processing.procedure.coding.code",
"path": "Specimen.processing.procedure.coding.code",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://fhir.nmdp.org/terminologyfhir/ValueSet//hla-immuno-assay-sample-treatment"
}
}
]
}
}

Terminology Bindings

These are the terminology bindings within this resource:

You need a license to run FQL queries

Constraints

These are the constraints (invariants) defined within this resource:

You need a license to run FQL queries