FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Orders and Observations icon Work Group  Maturity Level: 0 Trial Use Use Context: Any

Definitions for the medicalproductofhumanorigin Profile.

BiologicallyDerivedProduct
Element Id BiologicallyDerivedProduct
Definition

This profile is designed for biologically derived products that are derived from a human donor and intended for clinical application in a human recipient. Donor and recipient might, or might not, be the same individual. Products of this nature are referred to as medical products of human origin (MPHO) and have specific traceability requirements to ensure that the bi-directional link between donor and recipient is maintained. The profile specifies the essential identifiers for traceability as required elements.

Short Display Medical Product of Human Origin Profile
Cardinality 0..*
Comments

Substances include, but are not limited to: whole blood, bone marrow, organs, and manipulated blood cells.

Invariants
Inherited by this element
dom-2RuleIf the resource is contained in another resource, it SHALL NOT contain nested Resourcescontained.contained.empty()
dom-3RuleIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resourcecontained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4RuleIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdatedcontained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5RuleIf a resource is contained in another resource, it SHALL NOT have a security labelcontained.meta.security.empty()
dom-6GuidelineA resource should have narrative for robust managementtext.`div`.exists()
This is (only) a best practice guideline because:

When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.

BiologicallyDerivedProduct.id
Element Id BiologicallyDerivedProduct.id
Definition

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

Short Display Logical id of this artifact
Cardinality 0..1
Type id
Comments

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.

BiologicallyDerivedProduct.meta
Element Id BiologicallyDerivedProduct.meta
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.

Short Display Metadata about the resource
Cardinality 0..1
Type Meta
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.implicitRules
Element Id BiologicallyDerivedProduct.implicitRules
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.

Short Display A set of rules under which this content was created
Cardinality 0..1
Type uri
Is Modifier true (Reason: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation)
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 its narrative along with other profiles, value sets, etc.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.language
Element Id BiologicallyDerivedProduct.language
Definition

The base language in which the resource is written.

Short Display Language of the resource content
Cardinality 0..1
Terminology Binding IETF language tag for a human language
The codes SHALL be taken from All Languages
Type code
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).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.text
Element Id BiologicallyDerivedProduct.text
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.

Short Display Text summary of the resource, for human interpretation
Cardinality 0..1 This element is affected by the following invariants: dom-6
Type Narrative
Alternate Names narrative, html, xhtml, display
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.contained
Element Id BiologicallyDerivedProduct.contained
Definition

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.

Short Display Contained, inline Resources
Cardinality 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type Resource
Alternate Names inline 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.

BiologicallyDerivedProduct.extension
Element Id BiologicallyDerivedProduct.extension
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 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.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.modifierExtension
Element Id BiologicallyDerivedProduct.modifierExtension
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 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).

Short Display Extensions that cannot be ignored
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them)
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.

Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.productCategory
Element Id BiologicallyDerivedProduct.productCategory
Definition

A category or classification of the product. Products may be assigned multiple categories, for example a human heart valve can be categorized as an 'MPHO' and 'tissue'.

Short Display A category or classification of the product
Cardinality 1..*
Terminology Binding Biologically Derived Product Category.
For example codes, see Biologically Derived Product Category
Type CodeableConcept
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Slicing This element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:code, value:system
BiologicallyDerivedProduct.productCategory(MPHOCode)
Element Id BiologicallyDerivedProduct.productCategory:MPHOCode
Definition

A category or classification of the product. Products may be assigned multiple categories, for example a human heart valve can be categorized as an 'MPHO' and 'tissue'.

Short Display A category or classification of the product
Cardinality 1..1
Terminology Binding Biologically Derived Product Category.
For example codes, see Biologically Derived Product Category
Type CodeableConcept
Pattern Value <valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/product-category"/>
    <code value="mpho"/>
  </coding>
</valueCodeableConcept>
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.productCode
Element Id BiologicallyDerivedProduct.productCode
Definition

A codified value that systematically supports characterization and classification of medical products of human origin inclusive of processing conditions such as additives, volumes and handling conditions.

Short Display A code that identifies the kind of this biologically derived product
Cardinality 1..1
Terminology Binding Biologically-derived Product Codes
For example codes, see Biologically Derived Product Codes
Type CodeableConcept
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.productCode.id
Element Id BiologicallyDerivedProduct.productCode.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type id
BiologicallyDerivedProduct.productCode.extension
Element Id BiologicallyDerivedProduct.productCode.extension
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 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.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Slicing This element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
BiologicallyDerivedProduct.productCode.coding
Element Id BiologicallyDerivedProduct.productCode.coding
Definition

A reference to a code defined by a terminology system.

Short Display Code defined by a terminology system
Cardinality 1..*
Type Coding
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.productCode.coding.id
Element Id BiologicallyDerivedProduct.productCode.coding.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type id
BiologicallyDerivedProduct.productCode.coding.extension
Element Id BiologicallyDerivedProduct.productCode.coding.extension
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 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.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Slicing This element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
BiologicallyDerivedProduct.productCode.coding.system
Element Id BiologicallyDerivedProduct.productCode.coding.system
Definition

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

Short Display Identity of the terminology system
Cardinality 1..1
Type uri
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 be an absolute reference to some definition that establishes the system clearly and unambiguously.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.productCode.coding.version
Element Id BiologicallyDerivedProduct.productCode.coding.version
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.

Short Display Version of the system - if relevant
Cardinality 0..1
Type string
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.productCode.coding.code
Element Id BiologicallyDerivedProduct.productCode.coding.code
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).

Short Display Symbol in syntax defined by the system
Cardinality 1..1 This element is affected by the following invariants: cod-1
Type code
Requirements

Need to refer to a particular code in the system.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.productCode.coding.display
Element Id BiologicallyDerivedProduct.productCode.coding.display
Definition

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

Short Display Representation defined by the system
Cardinality 0..1 This element is affected by the following invariants: cod-1
Type string
Requirements

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.productCode.coding.userSelected
Element Id BiologicallyDerivedProduct.productCode.coding.userSelected
Definition

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

Short Display If this coding was chosen directly by the user
Cardinality 0..1
Type boolean
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.productCode.text
Element Id BiologicallyDerivedProduct.productCode.text
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.

Short Display Plain text representation of the concept
Cardinality 0..1
Type string
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.parent
Element Id BiologicallyDerivedProduct.parent
Definition

Parent product (if any) for this biologically-derived product.

Short Display The parent biologically-derived product
Cardinality 0..*
Type Reference(BiologicallyDerivedProduct)
Comments

For products that have multiple collections. For example Peripheral Blood Stem Cells may be collected over several days from a single donor and the donation split into in multiple containers which must be linked to the parent donation.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.request
Element Id BiologicallyDerivedProduct.request
Definition

Request to obtain and/or infuse this biologically derived product.

Short Display Request to obtain and/or infuse this product
Cardinality 0..*
Type Reference(ServiceRequest)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.identifier
Element Id BiologicallyDerivedProduct.identifier
Definition

Unique instance identifiers assigned to a biologically derived product. Note: This is a business identifier, not a resource identifier.

Short Display Under most circumstances an MPHO will be uniquely identified using a single identifier from production to point of use. In some cases, a second identifier may be required (for example, import from another country that uses a different identification coding system). In these cases, both the original and new identifier must be included.
Cardinality 1..*
Type Identifier
Comments

This identifier should uniquely identify the product instance in the business domain. Ideally it should be a globally unique identifier under the control of an ISO/IEC 15459 Issuing Agency.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.identifier.id
Element Id BiologicallyDerivedProduct.identifier.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type id
BiologicallyDerivedProduct.identifier.extension
Element Id BiologicallyDerivedProduct.identifier.extension
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 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.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Slicing This element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
BiologicallyDerivedProduct.identifier.use
Element Id BiologicallyDerivedProduct.identifier.use
Definition

The purpose of this identifier.

Short Display usual | official | temp | secondary | old (If known)
Cardinality 0..1
Terminology Binding Identifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Type code
Is Modifier true (Reason: This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.)
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.identifier.type
Element Id BiologicallyDerivedProduct.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Display Description of identifier
Cardinality 0..1
Terminology Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable
Type CodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.identifier.system
Element Id BiologicallyDerivedProduct.identifier.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Short Display Identity of the Issuing Agency responsible for the allocation of unique identifiers
Cardinality 1..1
Type uri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.identifier.value
Element Id BiologicallyDerivedProduct.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short Display Unique identifier of the MPHO item
Cardinality 1..1 This element is affected by the following invariants: ident-1
Type string
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.identifier.period
Element Id BiologicallyDerivedProduct.identifier.period
Definition

Time period during which identifier is/was valid for use.

Short Display Time period when id is/was valid for use
Cardinality 0..1
Type Period
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.identifier.assigner
Element Id BiologicallyDerivedProduct.identifier.assigner
Definition

Organization that issued/manages the identifier.

Short Display Organization that issued id (may be just text)
Cardinality 0..1
Type Reference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.biologicalSourceEvent
Element Id BiologicallyDerivedProduct.biologicalSourceEvent
Definition

An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled.

Short Display An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
Cardinality 1..1
Type Identifier
Comments

Necessary to support mandatory requirements for traceability from donor/source to recipient and vice versa, while also satisfying donor anonymity requirements. The element is defined consistently across BiologicallyDerivedProduct, NutritionProduct, and Device. The identifier references an event that links to a single biological entity such as a blood donor, or to multiple biological entities (e.g. when the product is an embryo or a pooled platelet product). A single biologicalSourceEvent identifier may appear on multiple products of many types derived from a single donation event or source extraction. As an example, a single donation event may provide 2 kidneys and a liver for organ transplantation, 2 corneas for eye surgery, heart valves and arterial tissue for cardiovascular surgery, multiple skin grafts, tendons, multiple shaped bone grafts and a large number of bone putty/paste products; and each of them may be assigned to the same biological source event identifier.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.biologicalSourceEvent.id
Element Id BiologicallyDerivedProduct.biologicalSourceEvent.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type id
BiologicallyDerivedProduct.biologicalSourceEvent.extension
Element Id BiologicallyDerivedProduct.biologicalSourceEvent.extension
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 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.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Slicing This element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
BiologicallyDerivedProduct.biologicalSourceEvent.use
Element Id BiologicallyDerivedProduct.biologicalSourceEvent.use
Definition

The purpose of this identifier.

Short Display usual | official | temp | secondary | old (If known)
Cardinality 0..1
Terminology Binding Identifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Type code
Is Modifier true (Reason: This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.)
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.biologicalSourceEvent.type
Element Id BiologicallyDerivedProduct.biologicalSourceEvent.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Display Description of identifier
Cardinality 0..1
Terminology Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable
Type CodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.biologicalSourceEvent.system
Element Id BiologicallyDerivedProduct.biologicalSourceEvent.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Short Display Identity of the Issuing Agency responsible for the allocation of unique identifiers
Cardinality 1..1
Type uri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.biologicalSourceEvent.value
Element Id BiologicallyDerivedProduct.biologicalSourceEvent.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short Display Unique identifier of the MPHO item
Cardinality 1..1 This element is affected by the following invariants: ident-1
Type string
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.biologicalSourceEvent.period
Element Id BiologicallyDerivedProduct.biologicalSourceEvent.period
Definition

Time period during which identifier is/was valid for use.

Short Display Time period when id is/was valid for use
Cardinality 0..1
Type Period
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.biologicalSourceEvent.assigner
Element Id BiologicallyDerivedProduct.biologicalSourceEvent.assigner
Definition

Organization that issued/manages the identifier.

Short Display Organization that issued id (may be just text)
Cardinality 0..1
Type Reference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.processingFacility
Element Id BiologicallyDerivedProduct.processingFacility
Definition

Processing facilities responsible for the labeling and distribution of this biologically derived product.

Short Display Processing facilities responsible for the labeling and distribution of this biologically derived product
Cardinality 0..*
Type Reference(Organization)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.division
Element Id BiologicallyDerivedProduct.division
Definition

A unique identifier for an aliquot of a product. Used to distinguish individual aliquots of a product carrying the same biologicalSource and productCode identifiers.

Short Display A unique identifier for an aliquot of a product
Cardinality 0..1
Type string
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.productStatus
Element Id BiologicallyDerivedProduct.productStatus
Definition

The current status of the product.

Short Display available | unavailable | processed | applied | discarded
Cardinality 0..1
Terminology Binding Biologically Derived Product Status.
For example codes, see Biologically Derived Product Status
Type Coding
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.expirationDate
Element Id BiologicallyDerivedProduct.expirationDate
Definition

Date, and where relevant time, of expiration.

Short Display Date, and where relevant time, of expiration
Cardinality 0..1
Type dateTime
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.collection
Element Id BiologicallyDerivedProduct.collection
Definition

How this product was collected.

Short Display How this product was collected
Cardinality 0..1
Type BackboneElement
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.collection.id
Element Id BiologicallyDerivedProduct.collection.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
BiologicallyDerivedProduct.collection.extension
Element Id BiologicallyDerivedProduct.collection.extension
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 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.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.collection.modifierExtension
Element Id BiologicallyDerivedProduct.collection.modifierExtension
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 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).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
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.

Alternate Names extensions, user content, modifiers
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.collection.collector
Element Id BiologicallyDerivedProduct.collection.collector
Definition

Healthcare professional who is performing the collection.

Short Display Individual performing collection
Cardinality 0..1
Type Reference(Practitioner)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.collection.source
Element Id BiologicallyDerivedProduct.collection.source
Definition

The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product.

Short Display The patient who underwent the medical procedure to collect the product or the organization that facilitated the collection
Cardinality 0..1
Type Reference(Patient)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.collection.collected[x]
Element Id BiologicallyDerivedProduct.collection.collected[x]
Definition

Time of product collection.

Short Display Time of product collection
Cardinality 0..1
Type Choice of: dateTime, Period
[x] Note See Choice of Datatypes for further information about how to use [x]
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.collection.procedure
Element Id BiologicallyDerivedProduct.collection.procedure
Definition

The procedure performed to collect the biologically derived product.

Short Display The procedure involved in the collection
Cardinality 0..1
Type Reference(Procedure)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.storageTempRequirements
Element Id BiologicallyDerivedProduct.storageTempRequirements
Definition

The temperature requirements for storage of the biologically-derived product.

Short Display Product storage temperature requirements
Cardinality 0..1
Type Range
Comments

May be extracted from information held in the Product Description Code.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.property
Element Id BiologicallyDerivedProduct.property
Definition

A property that is specific to this BiologicallyDerviedProduct instance.

Short Display A property that is specific to this BiologicallyDerviedProduct instance
Cardinality 0..*
Type BackboneElement
Comments

Property can be used to provide information on a wide range of additional information specific to a particular biologicallyDerivedProduct.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.property.id
Element Id BiologicallyDerivedProduct.property.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
BiologicallyDerivedProduct.property.extension
Element Id BiologicallyDerivedProduct.property.extension
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 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.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.property.modifierExtension
Element Id BiologicallyDerivedProduct.property.modifierExtension
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 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).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
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.

Alternate Names extensions, user content, modifiers
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.property.type
Element Id BiologicallyDerivedProduct.property.type
Definition

Code that specifies the property. It should reference an established coding system.

Short Display Code that specifies the property
Cardinality 1..1
Terminology Binding Biologically Derived Product Property Type Codes
For example codes, see Biologically Derived Product Property Type Codes
Type CodeableConcept
Comments

The element is identified by name and system URI in the type. Some types may have multiple occurrences.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
BiologicallyDerivedProduct.property.value[x]
Element Id BiologicallyDerivedProduct.property.value[x]
Definition

Property values.

Short Display Property values
Cardinality 1..1
Type Choice of: boolean, integer, CodeableConcept, Period, Quantity, Range, Ratio, string, Attachment
[x] Note See Choice of Datatypes for further information about how to use [x]
Comments

The value should be provided as a boolean, integer, CodeableConcept, period, quantity, range, ratio, or attachment. The description can be a string only when these others are not available. The type of value will depend on the property type and is specified in ST-027.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())