Generated Narrative: StructureDefinition ssidl-specimenDefinition-KU Name Flags Card. Type Description & Constraints SpecimenDefinition SpecimenDefinition Interfaces Implemented: MetadataResource #xD; url 1..1 uri Logical canonical URL to reference this SpecimenDefinition (globally unique) #xD; identifier 0..0 Business identifier #xD; version 0..0 Business version of the SpecimenDefinition #xD; versionAlgorithm[x] 0..0 How to compare versions #xD; name 0..0 Name for this {{title}} (computer friendly) #xD; title 0..0 Name for this SpecimenDefinition (Human friendly) #xD; derivedFromCanonical 0..0 Based on FHIR definition of another SpecimenDefinition #xD; derivedFromUri 0..0 Based on external definition #xD; status S 1..1 code draft | active | retired | unknown Required Pattern: active #xD; experimental 0..0 If this SpecimenDefinition is not for real usage #xD; subject[x] 0..0 Type of subject for specimen collection #xD; date 0..0 Date status first applied #xD; publisher 0..0 The name of the individual or organization that published the SpecimenDefinition #xD; contact 0..0 Contact details for the publisher #xD; useContext 1..1 UsageContext Content intends to support these contexts #xD; code 1..1 Coding Type of context being specified Required Pattern: At least the following #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: workflow #xD; display 1..1 string Representation defined by the system Fixed Value: Workflow Setting #xD; Slices for value[x] 1..1 CodeableConcept, Quantity, Range, Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) Value that defines the context Slice: Unordered, Open by type:$this #xD; value[x]:valueCodeableConcept 0..1 CodeableConcept Value that defines the context Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: KU #xD; jurisdiction 0..0 Intended jurisdiction for this SpecimenDefinition (if applicable) #xD; purpose 0..0 Why this SpecimenDefinition is defined #xD; copyright 0..0 Use and/or publishing restrictions #xD; copyrightLabel 0..0 Copyright holder and year(s) #xD; approvalDate 0..0 When SpecimenDefinition was approved by publisher #xD; lastReviewDate 0..0 The date on which the asset content was last reviewed by the publisher #xD; effectivePeriod 0..0 The effective date range for the SpecimenDefinition #xD; typeCollected #xD; coding S 1..1 Coding Code defined by a terminology system Binding: Kody materiałów laboratoryjnych (required) #xD; system S 1..1 uri Identity of the terminology system #xD; version 0..0 Version of the system - if relevant #xD; code S 1..1 code Symbol in syntax defined by the system #xD; display S 1..1 string Representation defined by the system #xD; userSelected 0..0 If this coding was chosen directly by the user #xD; text 0..0 Plain text representation of the concept #xD; patientPreparation S 0..* CodeableConcept Patient preparation for collection #xD; coding 0..0 Code defined by a terminology system #xD; text 1..1 string Plain text representation of the concept #xD; timeAspect 0..0 Time aspect for collection #xD; collection 0..0 Specimen collection procedure #xD; typeTested S 0..* BackboneElement Specimen in container intended for testing by lab #xD; isDerived 0..0 Primary or secondary specimen #xD; type S 0..1 CodeableConcept Type of intended specimen Binding: Słownik materiałów badanych (SSIDL) (required) #xD; coding S 1..* Coding Code defined by a terminology system #xD; system S 1..1 uri Identity of the terminology system #xD; version 0..0 Version of the system - if relevant #xD; code S 1..1 code Symbol in syntax defined by the system #xD; display S 1..1 string Representation defined by the system #xD; userSelected 0..0 If this coding was chosen directly by the user #xD; text 0..0 Plain text representation of the concept #xD; preference 1..1 code preferred | alternate Required Pattern: preferred #xD; container 0..0 The specimen's container #xD; requirement S 0..0 Requirements for specimen delivery and special handling #xD; retentionTime 0..0 The usual time for retaining this kind of specimen #xD; singleUse 0..0 Specimen for single use only #xD; rejectionCriterion 0..0 Criterion specified for specimen rejection #xD; handling S 0..1 BackboneElement Specimen handling before testing #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:code 1..1 Coding Typ czynnika przedanalitycznego (SSIDL) URL: http://loinc-ssidl.umed.pl/fhir/ig/ssidl/StructureDefinition/specimenDefinition-handlingCode Binding: http://loinc-ssidl.umed.pl/fhir/ig/ssidl/CodeSystem/ssidl-specimenHandlingCode-CS (required) #xD; instruction S 1..1 markdown Preservation instruction #xD; testingDestination 0..0 Where the specimen will be tested #xD; Documentation for this format
Czynniki przedanalityczne (SSIDL Katalog usług)
Definicja czynników przedanalitycznych dla definicji badania laboratoryjnego
A kind of specimen with associated set of requirements.
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
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.
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 its narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
The base language in which the resource is written.
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).
Text summary of the resource, for human interpretation
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.
Contained resources do not have a 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.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
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.
Additional content defined by implementations
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 managable, 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.
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.
Must have either extensions or value[x], not both
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 managable, 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).
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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Logical canonical URL to reference this SpecimenDefinition (globally unique)
An absolute URL that is used to identify this SpecimenDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this SpecimenDefinition is (or will be) published. The URL SHOULD include the major version of the SpecimenDefinition. For more information see Technical and Business Versions.
Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.
Allows the SpecimenDefinition to be referenced by a single globally unique identifier.
A business identifier assigned to this SpecimenDefinition.
Business version of the SpecimenDefinition
The identifier that is used to identify this version of the SpecimenDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the SpecimenDefinition author and is not expected to be globally unique.
There may be multiple different instances of a SpecimenDefinition that have the same identifier but different versions.
Indicates the mechanism used to compare versions to determine which is more current.
If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
Name for this {{title}} (computer friendly)
A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation.
The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
Support human navigation and code generation.
Name for this SpecimenDefinition (Human friendly)
A short, descriptive, user-friendly title for the SpecimenDefinition.
Based on FHIR definition of another SpecimenDefinition
The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition.
The URL pointing to an externally-defined type of specimen, guideline or other definition that is adhered to in whole or in part by this definition.
Specimen definitions may be refinements of other definitions.
The current state of theSpecimenDefinition.
A nominal state-transition diagram can be found in the [Definition pattern](http://hl7.org/fhir/R5/definition.html#statemachine) documentation Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
Not known why this is labelled a modifier
Codes identifying the status of a SpecimenDefinition resource.
If this SpecimenDefinition is not for real usage
A flag to indicate that this SpecimenDefinition is not authored for genuine usage.
Allows filtering of SpecimenDefinition that are appropriate for use vs. not.
If absent, this resource is treated as though it is not experimental.
A code or group definition that describes the intended subject from which this kind of specimen is to be collected.
Examples: person, animal, device, water ….
For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
The name of the individual or organization that published the SpecimenDefinition
Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contact.
Usually an organization, but may be an individual. The publisher (or steward) of the SpecimenDefinition is the organization or individual primarily responsible for the maintenance and upkeep of the SpecimenDefinition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the SpecimenDefinition. This item SHOULD be populated unless the information is available from context.
Contact details to assist a user in finding and communicating with the publisher.
May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
Natural language description of the SpecimenDefinition
A free text natural language description of the SpecimenDefinition from the consumer's perspective.
This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.
Content intends to support these contexts
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of specimen definitions.
When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.
Assist in searching for appropriate content.
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
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 managable, 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.
A code that identifies the type of context being specified by this usage context.
A code that specifies a type of context being specified by a usage context.
A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
A code that defines the specific value for the context being specified.
Intended jurisdiction for this SpecimenDefinition (if applicable)
A jurisdiction in which the SpecimenDefinition is intended to be used.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
Codes for country, country subdivision and region for indicating where a resource is intended to be used.
Explains why this SpecimeDefinition is needed and why it has been designed as it has.
This element does not describe the usage of the SpecimenDefinition. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this SpecimenDefinition.
Copyright statement relating to the SpecimenDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SpecimenDefinition.
Consumers of the SpecimenDefinition must be able to determine any legal restrictions on the use of the artifact and/or its content.
A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
Defines the content expected to be rendered in all representations of the artifact.
When SpecimenDefinition was approved by publisher
The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
The date may be more recent than the approval date because of minor changes / editorial corrections. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
The date on which the asset content was last reviewed by the publisher
The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
If specified, this is usually after the approval date. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
The effective date range for the SpecimenDefinition
The period during which the SpecimenDefinition content was or is planned to be effective.
The effective period for a SpecimenDefinition determines when the content is applicable for usage and is independent of publication and review dates. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
The type of the specimen to be collected.
A reference to a code defined by a terminology system.
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.
Allows for alternative encodings within a code system, and translations to other code systems.
fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
The identification of the code system that defines the meaning of the symbol in the code.
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Need to be unambiguous about the source of the definition of the symbol.
fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
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.
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.
fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
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).
Need to refer to a particular code in the system.
fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
A representation of the meaning of the code in the system, following the rules of the system.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
C*E.2 - but note this is not well followed
fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
If this coding was chosen directly by the user
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
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.
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.
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 ]
Plain text representation of the concept
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.
Very often the text is the same as a displayName of one of the codings.
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.
C*E.9. But note many systems use C*E.2 for this
fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Preparation of the patient for specimen collection.
SCT descendants of 703763000 |Precondition value (qualifier value)|
Time aspect of specimen collection (duration or offset).
The action to be performed for collecting the specimen.
SCT actions and procedures for specimen collection
Specimen in container intended for testing by lab
Specimen conditioned in a container as expected by the testing laboratory.
Extensions that cannot be ignored even if unrecognized
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 managable, 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).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
The kind of specimen conditioned for testing expected by lab.
The preference for this type of conditioned specimen.
Degree of preference of a type of conditioned specimen.
The material type used for the container
Kind of container associated with the kind of specimen
The type of container used to contain this kind of specimen.
SCT descendants of 706041008 |Device for body fluid and tissue collection/transfer/processing (physical object)|
From ISO 6710-2017 Table F.1 Recommended colour codes.
The description of the kind of container
The textual description of the kind of container.
The capacity (volume or other measure) of this kind of container.
The minimum volume to be conditioned in the container.
Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
Special processing applied to the container for this specimen type
Special processing that should be applied to the container for this kind of specimen.
Requirements for specimen delivery and special handling
Requirements for delivery and special handling of this kind of conditioned specimen.
The usual time for retaining this kind of specimen
The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.
Specimen can be used by only one test or panel if the value is "true".
Criterion specified for specimen rejection
Criterion for rejection of the specimen in its container by the laboratory.
Criterion for rejection of the specimen by laboratory.
Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.
It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element.
Set of handling instructions prior testing of the specimen.
Temperature range for these handling instructions
The temperature interval for this set of handling instructions.
The maximum time interval of preservation of the specimen with these conditions.
Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'.
Where the specimen will be tested: e.g., lab, sector, device or any combination of these.
Codes specifying where the specimen will be tested.