0.1.0 - ci-build
SENAITEFHIRImplementationGuide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2026-11-05 |
Definitions for the SenaiteRequestBundle resource profile.
See the documentation on how to interpret the contents of this table
| 0. Bundle | |
| Definition | A container for a collection of resources. |
| Short | Contains a collection of resources |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | bdl-1: total only when a search or history (total.empty() or (type = 'searchset') or (type = 'history')) bdl-2: entry.search only when a search ((type = 'searchset') or entry.search.empty()) bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) ((type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()) bdl-9: A document must have an identifier with a system and a value (type = 'document' implies (identifier.system.exists() and identifier.value.exists())) bdl-10: A document must have a date (type = 'document' implies (timestamp.hasValue())) bdl-11: A document must have a Composition as the first resource (type = 'document' implies entry.first().resource.is(Composition)) bdl-12: A message must have a MessageHeader as the first resource (type = 'message' implies entry.first().resource.is(MessageHeader)) bdl-13: A subscription-notification must have a SubscriptionStatus as the first resource (type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)) bdl-14: entry.request.method PATCH not allowed for history (type = 'history' implies entry.request.method != 'PATCH') bdl-15: Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated (type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')) bdl-16: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. (issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')) bdl-17: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. (type = 'document' implies issues.empty()) bdl-18: Self link is required for searchsets. (type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()) bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements (type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())) bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH (type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))) bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH (type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))) bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements (type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())) |
| 2. Bundle.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 | A set of rules under which this content was created |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. Bundle.identifier | |
| Definition | A persistent identifier for the bundle that won't change as a bundle is copied from server to server. |
| Short | Persistent identifier for the bundle |
| Comments | Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..01 This element is affected by the following invariants: bdl-9 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. Bundle.type | |
| Definition | Indicates the purpose of this bundle - how it is intended to be used. |
| Short | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification |
| Comments | It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. |
| Control | 1..1 This element is affected by the following invariants: bdl-1, bdl-2, bdl-3a, bdl-3b, bdl-3c, bdl-3d, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-17, bdl-18 |
| Binding | The codes SHALL be taken from BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|5.0.0 (required to http://hl7.org/fhir/ValueSet/bundle-type|5.0.0)Indicates the purpose of a bundle - how it is intended to be used. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. Bundle.timestamp | |
| Definition | The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. |
| Short | When the bundle was assembled |
| Comments | For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated. Usage:
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself. |
| Control | 0..01 This element is affected by the following invariants: bdl-10 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Bundle.total | |
| Definition | If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. |
| Short | If search, the total number of matches |
| Comments | Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources. |
| Control | 0..01 This element is affected by the following invariants: bdl-1 |
| Type | unsignedInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. Bundle.link | |
| Definition | A series of links that provide context to this bundle. |
| Short | Links related to this Bundle |
| Comments | Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS). Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly. This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners. |
| Control | 0..0* This element is affected by the following invariants: bdl-18 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 17. Bundle.entry | |
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | Entry in the bundle - will have a resource or information |
| Control | 20..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists()) bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Bundle.entry. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
|
| 19. Bundle.entry.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 21. Bundle.entry.fullUrl | |
| Definition | The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
|
| Short | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). |
| Control | 0..1 This element is affected by the following invariants: bdl-7, bdl-15, bdl-8 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 23. Bundle.entry.resource | |
| Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning. |
| Short | A resource in the bundle |
| Control | 0..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 25. Bundle.entry.request | |
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. |
| Short | Additional execution information (transaction/batch/history) |
| Control | 0..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 27. Bundle.entry.request.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 29. Bundle.entry.request.method | |
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. |
| Short | GET | HEAD | POST | PUT | DELETE | PATCH |
| Control | 1..1 This element is affected by the following invariants: bdl-3b, bdl-3c, bdl-14, bdl-15 |
| Binding | The codes SHALL be taken from HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 (required to http://hl7.org/fhir/ValueSet/http-verb|5.0.0)HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 31. Bundle.entry.request.url | |
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). |
| Short | URL for HTTP equivalent of this entry |
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 33. Bundle.entry.response | |
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. |
| Short | Results of execution (transaction/batch/history) |
| Control | 0..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3d, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 35. Bundle.entry.response.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 37. Bundle.entry.response.status | |
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. |
| Short | Status response code (text optional) |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 39. Bundle.entry:serviceRequest | |
| Slice Name | serviceRequest |
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | Entry in the bundle - will have a resource or information |
| Control | 10..1* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists()) bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 41. Bundle.entry:serviceRequest.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 43. Bundle.entry:serviceRequest.fullUrl | |
| Definition | The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
|
| Short | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). |
| Control | 10..1 This element is affected by the following invariants: bdl-7, bdl-15, bdl-8 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) urn-uuid: fullUrl must be a urn:uuid: reference for POST transaction entries ( matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')) |
| 45. Bundle.entry:serviceRequest.resource | |
| Definition | A record of a request for service such as diagnostic investigations, treatments, or operations to be performed. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning. |
| Short | A request for a service to be performedA resource in the bundle |
| Control | 10..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 |
| Type | ServiceRequestResource(SENAITE Service Request |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | diagnostic request, referral, referral request, transfer of care request |
| 47. Bundle.entry:serviceRequest.resource.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| 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. |
| Control | 0..01 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 49. Bundle.entry:serviceRequest.resource.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 | A set of rules under which this content was created |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 51. Bundle.entry:serviceRequest.resource.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 | Contained, inline 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. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 53. Bundle.entry:serviceRequest.resource.extension | |
| Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 10..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 55. Bundle.entry:serviceRequest.resource.extension:client | |
| Slice Name | client |
| Definition | A direct reference to the Organisation that is placing this laboratory request. In SENAITE this maps to the Client registered in the LIMS. If the client is not yet known, it will be created on receipt. |
| Short | The submitting client organisation |
| Control | 1..1 |
| Type | Extension(SENAITE Client) (Extension Type: Reference(SenaiteOrganization)) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | 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()) |
| 57. Bundle.entry:serviceRequest.resource.modifierExtension | |
| Definition | An Extension 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 | ExtensionExtensions that cannot be ignored |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 59. Bundle.entry:serviceRequest.resource.identifier | |
| Definition | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
| Short | Not used — see identifiers.html#sample-identifiersIdentifiers assigned to this order |
| Comments | The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 V2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 V2). For further discussion and examples see the resource notes section below. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..0* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 61. Bundle.entry:serviceRequest.resource.instantiatesCanonical | |
| Definition | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. |
| Short | Instantiates FHIR protocol or definition |
| Comments | The PlanDefinition resource is used to describe series, sequences, or groups of actions to be taken, while the ActivityDefinition resource is used to define each specific step or activity to be performed. More information can be found in the Boundaries and Relationships section for PlanDefinition. The PlanDefinition resource is used to describe series, sequences, or groups of actions to be taken, while the ActivityDefinition resource is used to define each specific step or activity to be performed. More information can be found in the Boundaries and Relationships section for PlanDefinition. |
| Control | 0..0* |
| Type | canonical(ActivityDefinition, PlanDefinition) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 63. Bundle.entry:serviceRequest.resource.instantiatesUri | |
| Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. |
| Short | Instantiates external protocol or definition |
| Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. |
| Control | 0..0* |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 65. Bundle.entry:serviceRequest.resource.basedOn | |
| Definition | Plan/proposal/order fulfilled by this request. |
| Short | What request fulfills |
| Control | 0..0* |
| Type | Reference(CarePlan, ServiceRequest, MedicationRequest) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | fulfills |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 67. Bundle.entry:serviceRequest.resource.replaces | |
| Definition | The request takes the place of the referenced completed or terminated request(s). |
| Short | What request replaces |
| Control | 0..0* |
| Type | Reference(ServiceRequest) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | supersedes, prior, renewed order |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 69. Bundle.entry:serviceRequest.resource.status | |
| Definition | The status of the order. |
| Short | draft | active | on-hold | revoked | entered-in-errordraft | active | on-hold | revoked | completed | entered-in-error | unknown |
| Comments | The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, revoked or placed on-hold. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource. The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, revoked or placed on-hold. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RequestStatushttp://hl7.org/fhir/ValueSet/request-status|5.0.0 (required to http://hl7.org/fhir/ValueSet/request-status|5.0.0)The status of a service order. |
| Type | code |
| Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 71. Bundle.entry:serviceRequest.resource.intent | |
| Definition | Whether the request is a proposal, plan, an original order or a reflex order. |
| Short | order | reflex-orderproposal | plan | directive | order + |
| Comments | This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|5.0.0 (required to http://hl7.org/fhir/ValueSet/request-intent|5.0.0)The kind of service request. |
| Type | code |
| Is Modifier | true because This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 73. Bundle.entry:serviceRequest.resource.category | |
| Definition | This will always be a Laboratory procedure A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). |
| Short | Classification of service |
| Comments | There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set. |
| Control | 10..1* |
| Binding | The codes SHALL be taken from For example codes, see ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-category|5.0.0 (required to http://hl7.org/fhir/ValueSet/servicerequest-category)Classification of the requested service. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Used for filtering what service request are retrieved and displayed. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 75. Bundle.entry:serviceRequest.resource.category.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 | Plain text representation of the concept |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 77. Bundle.entry:serviceRequest.resource.doNotPerform | |
| Definition | Set this to true if the record is saying that the service/procedure should NOT be performed. |
| Short | True if service/procedure should not be performed |
| Comments | In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation. |
| Control | 0..01 |
| Type | boolean |
| Is Modifier | true because If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Used for do not ambulate, do not elevate head of bed, do not flush NG tube, do not take blood pressure on a certain arm, etc. |
| Meaning if Missing | If missing, the request is a positive request e.g. "do perform" |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 79. Bundle.entry:serviceRequest.resource.code | |
| Definition | A code or reference that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested. |
| Short | What is being requested/ordered |
| Comments | Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code. |
| Control | 10..1 This element is affected by the following invariants: prr-1 |
| Binding | The codes SHOULD be taken from For example codes, see http://loinc.orghttp://hl7.org/fhir/ValueSet/procedure-code|5.0.0 (preferred to http://loinc.org)For laboratory codes Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. |
| Type | CodeableReference(ActivityDefinition, PlanDefinition) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | service requested |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 81. Bundle.entry:serviceRequest.resource.code.extension | |
| Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.code.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 83. Bundle.entry:serviceRequest.resource.quantity[x] | |
| Definition | An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction). |
| Short | Service amount |
| Control | 0..01 |
| Type | Choice of: Quantity, Ratio, Range |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | When ordering a service the number of service items may need to be specified separately from the the service item. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 85. Bundle.entry:serviceRequest.resource.subject | |
| Definition | On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans). |
| Short | Individual or Entity the service is ordered for |
| Control | 1..1 |
| Type | Reference(Patient, Group, Location, Device) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 87. Bundle.entry:serviceRequest.resource.subject.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Control | 0..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) subject-identified: If there is no identifier then it must have a key ( hasValue() or subject.identifier.count()) |
| 89. Bundle.entry:serviceRequest.resource.subject.type | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Control | 0..01 |
| Binding | Unless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|5.0.0 (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)Aa resource (or, for logical models, the URI of the logical model). |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 91. Bundle.entry:serviceRequest.resource.subject.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..01 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 93. Bundle.entry:serviceRequest.resource.encounter | |
| Definition | An encounter that provides additional information about the healthcare context in which this request is made. |
| Short | Encounter in which the request was created |
| Control | 0..01 |
| Type | Reference(Encounter) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | context |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 95. Bundle.entry:serviceRequest.resource.occurrence[x] | |
| Definition | The date/time at which the requested service should occur. |
| Short | When service should occur |
| Control | 0..01 |
| Type | Choice of: dateTime, Period, Timing |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Alternate Names | schedule |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 97. Bundle.entry:serviceRequest.resource.asNeeded[x] | |
| Definition | If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. |
| Short | Preconditions for service |
| Control | 0..01 |
| Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason|5.0.0 (example to http://hl7.org/fhir/ValueSet/medication-as-needed-reason|5.0.0)A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. |
| Type | Choice of: boolean, CodeableConcept |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 99. Bundle.entry:serviceRequest.resource.authoredOn | |
| Definition | When the request transitioned to being actionable. |
| Short | Date request signed |
| Control | 0..01 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Alternate Names | orderedOn |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 101. Bundle.entry:serviceRequest.resource.performerType | |
| Definition | Desired type of performer for doing the requested service. |
| Short | Performer role |
| Comments | This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, “compounding pharmacy”, “psychiatrist” or “internal referral”. |
| Control | 0..01 |
| Binding | For example codes, see ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-role|5.0.0 (example to http://hl7.org/fhir/ValueSet/participant-role|5.0.0)Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | specialty |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 103. Bundle.entry:serviceRequest.resource.performer | |
| Definition | The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. |
| Short | Requested performer |
| Comments | If multiple performers are present, it is interpreted as a list of alternative performers without any preference regardless of order. If order of preference is needed use the http://hl7.org/fhir/StructureDefinition/request-performerOrder. Use CareTeam to represent a group of performers (for example, Practitioner A and Practitioner B). |
| Control | 0..0* |
| Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Patient, Device, RelatedPerson) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | request recipient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 105. Bundle.entry:serviceRequest.resource.location | |
| Definition | The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center. |
| Short | Requested location |
| Control | 0..0* |
| Binding | For example codes, see ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType (example to http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType)A location type where services are delivered. |
| Type | CodeableReference(Location) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 107. Bundle.entry:serviceRequest.resource.reason | |
| Definition | An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in |
| Short | Explanation/Justification for procedure or service |
| Comments | This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise, use This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise, use |
| Control | 0..0* |
| Binding | For example codes, see ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason|5.0.0 (example to http://hl7.org/fhir/ValueSet/procedure-reason|5.0.0)SNOMED CT Condition/Problem/Diagnosis Codes |
| Type | CodeableReference(Condition, Observation, DiagnosticReport, DocumentReference, DetectedIssue) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 109. Bundle.entry:serviceRequest.resource.insurance | |
| Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. |
| Short | Associated insurance coverage |
| Control | 0..0* |
| Type | Reference(Coverage, ClaimResponse) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 111. Bundle.entry:serviceRequest.resource.supportingInfo | |
| Definition | Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements. |
| Short | Additional clinical information |
| Comments | To represent information about how the services are to be delivered use the |
| Control | 0..0* |
| Type | CodeableReference(Resource) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | Ask at order entry question, AOE |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 113. Bundle.entry:serviceRequest.resource.specimen | |
| Definition | One or more specimens that the laboratory procedure will use. |
| Short | Procedure Samples |
| Comments | The purpose of the ServiceRequest.specimen is to reflect the actual specimen that the requested test/procedure is asked to be performed on, whether the lab already has it or not. References to specimens for purposes other than to perform a test/procedure on should be made using the ServiceRequest.supportingInfo or the Specimen.parent where the Specimen.parent would enable descendency and ServiceRequest.supportingInfo a general reference for context. |
| Control | 10..1* |
| Type | Reference(Specimen) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 115. Bundle.entry:serviceRequest.resource.specimen.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Control | 10..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 117. Bundle.entry:serviceRequest.resource.bodySite | |
| Definition | Anatomic location where the procedure should be performed. This is the target site. |
| Short | Coded location on Body |
| Comments | Only used if not implicit in the code found in ServiceRequest.code. 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 http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure. |
| Control | 0..0* This element is affected by the following invariants: bdystr-1 |
| Binding | For example codes, see SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site|5.0.0 (example to http://hl7.org/fhir/ValueSet/body-site|5.0.0)SNOMED CT Body site concepts |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Knowing where the procedure is performed is important for tracking if multiple sites are possible. |
| Alternate Names | location |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 119. Bundle.entry:serviceRequest.resource.patientInstruction | |
| Definition | Instructions in terms that are understood by the patient or consumer. |
| Short | Patient or consumer-oriented instructions |
| Control | 0..0* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 122. Bundle.entry:serviceRequest.resource.relevantHistory | |
| Definition | Key events in the history of the request. |
| Short | Request provenance |
| Comments | This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject. |
| Control | 0..0* |
| Type | Reference(Provenance) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 124. Bundle.entry:serviceRequest.search | |
| Definition | Information about the search process that lead to the creation of this entry. |
| Short | Search related information |
| Control | 0..01 This element is affected by the following invariants: bdl-2 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 127. Bundle.entry:serviceRequest.request | |
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. |
| Short | Additional execution information (transaction/batch/history) |
| Control | 10..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 129. Bundle.entry:serviceRequest.request.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 131. Bundle.entry:serviceRequest.request.method | |
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. |
| Short | GET | HEAD | POST | PUT | DELETE | PATCH |
| Control | 1..1 This element is affected by the following invariants: bdl-3b, bdl-3c, bdl-14, bdl-15 |
| Binding | The codes SHALL be taken from HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 (required to http://hl7.org/fhir/ValueSet/http-verb|5.0.0)HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 133. Bundle.entry:serviceRequest.request.url | |
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). |
| Short | URL for HTTP equivalent of this entry |
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 135. Bundle.entry:serviceRequest.request.ifNoneExist | |
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). |
| Short | For conditional creates |
| Control | 0..01 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 137. Bundle.entry:serviceRequest.response | |
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. |
| Short | Results of execution (transaction/batch/history) |
| Control | 0..01 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3d, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 141. Bundle.entry:patient | |
| Slice Name | patient |
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | Entry in the bundle - will have a resource or information |
| Control | 0..1* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists()) bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 143. Bundle.entry:patient.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 145. Bundle.entry:patient.fullUrl | |
| Definition | The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
|
| Short | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). |
| Control | 10..1 This element is affected by the following invariants: bdl-7, bdl-15, bdl-8 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) urn-uuid: fullUrl must be a urn:uuid: reference for POST transaction entries ( matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')) |
| 147. Bundle.entry:patient.resource | |
| Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning. |
| Short | Information about an individual or animal receiving health care servicesA resource in the bundle |
| Control | 10..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 |
| Type | PatientResource(SenaitePatient |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | SubjectOfCare Client Resident |
| Invariants | no-internal-id-on-create: The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create (identifier.where(use = 'usual').empty()) |
| 149. Bundle.entry:patient.resource.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| 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. |
| Control | 0..01 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 151. Bundle.entry:patient.resource.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 | A set of rules under which this content was created |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 153. Bundle.entry:patient.resource.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 | Contained, inline 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. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 155. Bundle.entry:patient.resource.extension:estimatedDateBirth | |
| Slice Name | estimatedDateBirth |
| Definition | true if the date of birth is unknown precisely |
| Short | If the date of birth was not known precisely |
| Control | 0..1 |
| Type | Extension(EstimatedDateBirth) (Extension Type: boolean) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | 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()) |
| 157. Bundle.entry:patient.resource.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 | Extensions that cannot be ignored |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 159. Bundle.entry:patient.resource.identifier | |
| Definition | An identifier for this patient. |
| Short | An identifier for this patient |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Patients are almost always assigned specific numerical identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 161. Bundle.entry:patient.resource.identifier:senaiteId | |
| Slice Name | senaiteId |
| Definition | The internal SENAITE Patient ID. Human readable and generated by SENAITE when the Patient is created. It must not be supplied by a client on an external create — a POST entry carrying it is rejected. Once assigned it may be used to identify the Patient on reads, on subsequent updates, and in Bundle.entry.request.ifNoneExist. An identifier for this patient. |
| Short | Internal SENAITE Patient ID — server-assigned, do not include on createAn identifier for this patient |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Patients are almost always assigned specific numerical identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 163. Bundle.entry:patient.resource.identifier:senaiteId.extension | |
| Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 165. Bundle.entry:patient.resource.identifier:senaiteId.use | |
| Definition | The purpose of this identifier. |
| Short | usualusual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 167. Bundle.entry:patient.resource.identifier:senaiteId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..01 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0 (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 169. Bundle.entry:patient.resource.identifier:senaiteId.system | |
| Definition | The namespace for the internal SENAITE Patient ID. Mandatory. Configurable per deployment; where a deployment has not defined its own URI, use the default https://fhir.senaite.org/NamingSystem/patient-id declared by SenaitePatientIdNamingSystem. Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | Internal Patient ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/patient-idThe namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 10..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 171. Bundle.entry:patient.resource.identifier:senaiteId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | Internal SENAITE patient identifier — alphanumeric and hyphens onlyThe value that is unique |
| 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. |
| Control | 10..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 173. Bundle.entry:patient.resource.identifier:senaiteId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..01 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 175. Bundle.entry:patient.resource.identifier:senaiteId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..01 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 177. Bundle.entry:patient.resource.identifier:mrn | |
| Slice Name | mrn |
| Definition | The consumer-owned business identifier for the patient — most often a Medical Record Number (MRN) — originating in the API consumer's system. Unlike the internal ID this may be supplied on create, and is preserved as-is by SENAITE. An identifier for this patient. |
| Short | External Patient ID from the consumer's system — may be supplied on createAn identifier for this patient |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Patients are almost always assigned specific numerical identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 179. Bundle.entry:patient.resource.identifier:mrn.extension | |
| Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 181. Bundle.entry:patient.resource.identifier:mrn.use | |
| Definition | The purpose of this identifier. |
| Short | secondaryusual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 183. Bundle.entry:patient.resource.identifier:mrn.system | |
| Definition | The namespace for the consumer's own patient identifier. Mandatory. Normally the URI of the consumer's patient registry, agreed at integration time; where the consumer or deployment has none, use the default https://fhir.senaite.org/NamingSystem/patient-mrn declared by SenaitePatientMrnNamingSystem. A system is required because request.ifNoneExist and the identifier search parameter match on system and value and ignore Identifier.use. Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | External Patient ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/patient-mrnThe namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 10..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 185. Bundle.entry:patient.resource.identifier:mrn.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | External patient identifier, typically an MRN — alphanumeric and hyphens onlyThe value that is unique |
| 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. |
| Control | 10..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 187. Bundle.entry:patient.resource.identifier:mrn.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..01 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 189. Bundle.entry:patient.resource.identifier:mrn.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..01 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 191. Bundle.entry:patient.resource.active | |
| Definition | Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. |
| Short | Whether this patient's record is in active use |
| Comments | If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Need to be able to mark a patient record as not to be used because it was created in error. |
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 193. Bundle.entry:patient.resource.name | |
| Definition | A name associated with the individual. |
| Short | A name associated with the patient |
| Comments | A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Animal names may be communicated as given names, and optionally may include a family name. |
| Control | 10..* |
| Type | HumanName |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 195. Bundle.entry:patient.resource.name.use | |
| Definition | Identifies the purpose for this name. |
| Short | usual | official | temp | nickname | anonymous | old | maiden |
| Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/name-use|5.0.0)The use of a human name. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 197. Bundle.entry:patient.resource.name.text | |
| Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. |
| Short | Text representation of the full name |
| Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
| Control | 0..01 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | A renderable, unencoded form. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 199. Bundle.entry:patient.resource.name.period | |
| Definition | Indicates the period of time when this name was valid for the named person. |
| Short | Time period when name was/is in use |
| Control | 0..01 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows names to be placed in historical context. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 201. Bundle.entry:patient.resource.gender | |
| Definition | Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. |
| Short | male | female | other | unknown |
| Comments | The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 (required to http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0)The gender of a person used for administrative purposes. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Needed for identification of the individual, in combination with (at least) name and birth date. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 203. Bundle.entry:patient.resource.birthDate | |
| Definition | The date of birth for the individual. |
| Short | The date of birth for the individual |
| Comments | Partial dates are allowed if the specific date of birth is unknown. There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). |
| Control | 10..1 |
| Type | date |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Age of the individual drives many clinical processes. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 205. Bundle.entry:patient.resource.deceased[x] | |
| Definition | Indicates if the individual is deceased or not. |
| Short | Indicates if the individual is deceased or not |
| Comments | If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. |
| Control | 0..1 |
| Type | dateTime, boolean |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 207. Bundle.entry:patient.resource.multipleBirth[x] | |
| Definition | Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). |
| Short | Whether patient is part of a multiple birth |
| Comments | Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). |
| Control | 0..01 |
| Type | Choice of: boolean, integer |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 209. Bundle.entry:patient.resource.photo | |
| Definition | Image of the patient. |
| Short | Image of the patient |
| Comments | Guidelines:
|
| Control | 0..0* |
| Type | Attachment |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 211. Bundle.entry:patient.resource.contact | |
| Definition | A contact party (e.g. guardian, partner, friend) for the patient. |
| Short | A contact party (e.g. guardian, partner, friend) for the patient |
| Comments | Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact. |
| Control | 0..0* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Need to track people you can contact about the patient. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists()) |
| 214. Bundle.entry:patient.resource.communication | |
| Definition | A language which may be used to communicate with the patient about his or her health. |
| Short | A language which may be used to communicate with the patient about his or her health |
| Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. |
| Control | 0..0* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 218. Bundle.entry:patient.resource.generalPractitioner | |
| Definition | Patient's nominated care provider. |
| Short | Patient's nominated primary care provider |
| Comments | This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type. |
| Control | 0..0* |
| Type | Reference(Organization, Practitioner, PractitionerRole) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | careProvider |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 220. Bundle.entry:patient.resource.managingOrganization | |
| Definition | Organization that is the custodian of the patient record. |
| Short | Organization that is the custodian of the patient record |
| Comments | There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). |
| Control | 0..01 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Need to know who recognizes this patient record, manages and updates it. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 222. Bundle.entry:patient.resource.link | |
| Definition | Link to a Patient or RelatedPerson resource that concerns the same actual individual. |
| Short | Link to a Patient or RelatedPerson resource that concerns the same actual individual |
| Comments | There is no assumption that linked patient records have mutual links. |
| Control | 0..0* |
| Type | BackboneElement |
| Is Modifier | true because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by' |
| Must Support | false |
| Summary | true |
| Requirements | There are multiple use cases:
|
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 227. Bundle.entry:patient.search | |
| Definition | Information about the search process that lead to the creation of this entry. |
| Short | Search related information |
| Control | 0..01 This element is affected by the following invariants: bdl-2 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 230. Bundle.entry:patient.request | |
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. |
| Short | Additional execution information (transaction/batch/history) |
| Control | 10..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 232. Bundle.entry:patient.request.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 234. Bundle.entry:patient.request.method | |
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. |
| Short | GET | HEAD | POST | PUT | DELETE | PATCH |
| Control | 1..1 This element is affected by the following invariants: bdl-3b, bdl-3c, bdl-14, bdl-15 |
| Binding | The codes SHALL be taken from HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 (required to http://hl7.org/fhir/ValueSet/http-verb|5.0.0)HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 236. Bundle.entry:patient.request.url | |
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). |
| Short | URL for HTTP equivalent of this entry |
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 238. Bundle.entry:patient.request.ifNoneExist | |
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). |
| Short | For conditional creates |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ifnoneexist-on-identifier: ifNoneExist must key on the resource's external (secondary) or internal (usual) identifier, and must include a system: identifier=<system>|<value> ( $this.matches('^identifier=[^|]+\|[^|]+$')) |
| 240. Bundle.entry:patient.response | |
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. |
| Short | Results of execution (transaction/batch/history) |
| Control | 0..01 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3d, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 244. Bundle.entry:practitioner | |
| Slice Name | practitioner |
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | Entry in the bundle - will have a resource or information |
| Control | 0..1* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists()) bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 246. Bundle.entry:practitioner.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 248. Bundle.entry:practitioner.fullUrl | |
| Definition | The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
|
| Short | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). |
| Control | 10..1 This element is affected by the following invariants: bdl-7, bdl-15, bdl-8 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) urn-uuid: fullUrl must be a urn:uuid: reference for POST transaction entries ( matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')) |
| 250. Bundle.entry:practitioner.resource | |
| Definition | A person who is directly or indirectly involved in the provisioning of healthcare or related services. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning. |
| Short | A person with a formal responsibility in the provisioning of healthcare or related servicesA resource in the bundle |
| Control | 10..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 |
| Type | PractitionerResource(SenaitePractitioner |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | no-internal-id-on-create: The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create (identifier.where(use = 'usual').empty()) |
| 252. Bundle.entry:practitioner.resource.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| 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. |
| Control | 0..01 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 254. Bundle.entry:practitioner.resource.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 | A set of rules under which this content was created |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 256. Bundle.entry:practitioner.resource.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 | Contained, inline 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. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 258. Bundle.entry:practitioner.resource.extension | |
| Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 260. Bundle.entry:practitioner.resource.modifierExtension | |
| Definition | An Extension 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 | ExtensionExtensions that cannot be ignored |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 262. Bundle.entry:practitioner.resource.identifier | |
| Definition | An identifier that applies to this person in this role. |
| Short | An identifier for the person as this agent |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Often, specific identities are assigned for the agent. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
|
| 264. Bundle.entry:practitioner.resource.identifier:senaiteId | |
| Slice Name | senaiteId |
| Definition | The internal SENAITE Practitioner ID. Human readable and generated by SENAITE when the Practitioner is created. It must not be supplied by a client on an external create — a POST entry carrying it is rejected. Once assigned it may be used to identify the Practitioner on reads, on subsequent updates, and in Bundle.entry.request.ifNoneExist. An identifier that applies to this person in this role. |
| Short | Internal SENAITE Practitioner ID — server-assigned, do not include on createAn identifier for the person as this agent |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Often, specific identities are assigned for the agent. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 266. Bundle.entry:practitioner.resource.identifier:senaiteId.extension | |
| Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 268. Bundle.entry:practitioner.resource.identifier:senaiteId.use | |
| Definition | The purpose of this identifier. |
| Short | usualusual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 270. Bundle.entry:practitioner.resource.identifier:senaiteId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..01 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0 (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 272. Bundle.entry:practitioner.resource.identifier:senaiteId.system | |
| Definition | The namespace for the internal SENAITE Practitioner ID. Mandatory. Configurable per deployment; where a deployment has not defined its own URI, use the default https://fhir.senaite.org/NamingSystem/practitioner-id declared by SenaitePractitionerIdNamingSystem. Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | Internal Practitioner ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/practitioner-idThe namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 10..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 274. Bundle.entry:practitioner.resource.identifier:senaiteId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | Internal SENAITE practitioner identifier — alphanumeric and hyphens onlyThe value that is unique |
| 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. |
| Control | 10..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 276. Bundle.entry:practitioner.resource.identifier:senaiteId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..01 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 278. Bundle.entry:practitioner.resource.identifier:senaiteId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..01 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 280. Bundle.entry:practitioner.resource.identifier:externalId | |
| Slice Name | externalId |
| Definition | The consumer-owned business identifier for the practitioner, for example a national provider number or hospital staff ID, originating in the API consumer's system. Unlike the internal ID this may be supplied on create, and is preserved as-is by SENAITE. An identifier that applies to this person in this role. |
| Short | External Practitioner ID from the consumer's system — may be supplied on createAn identifier for the person as this agent |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Often, specific identities are assigned for the agent. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 282. Bundle.entry:practitioner.resource.identifier:externalId.extension | |
| Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 284. Bundle.entry:practitioner.resource.identifier:externalId.use | |
| Definition | The purpose of this identifier. |
| Short | secondaryusual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 286. Bundle.entry:practitioner.resource.identifier:externalId.system | |
| Definition | The namespace for the consumer's own practitioner identifier. Mandatory. Normally the URI of the consumer's provider registry, agreed at integration time; where the consumer or deployment has none, use the default https://fhir.senaite.org/NamingSystem/practitioner-external-id declared by SenaitePractitionerExternalIdNamingSystem. A system is required because request.ifNoneExist and the identifier search parameter match on system and value and ignore Identifier.use. Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | External Practitioner ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/practitioner-external-idThe namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 10..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 288. Bundle.entry:practitioner.resource.identifier:externalId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | External practitioner identifier — alphanumeric and hyphens onlyThe value that is unique |
| 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. |
| Control | 10..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 290. Bundle.entry:practitioner.resource.identifier:externalId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..01 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 292. Bundle.entry:practitioner.resource.identifier:externalId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..01 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 294. Bundle.entry:practitioner.resource.active | |
| Definition | Whether this practitioner's record is in active use. |
| Short | Whether this practitioner's record is in active use |
| Comments | If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Need to be able to mark a practitioner record as not to be used because it was created in error. |
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 296. Bundle.entry:practitioner.resource.name | |
| Definition | The name(s) associated with the practitioner. |
| Short | The name(s) associated with the practitioner |
| Comments | The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this:
|
| Control | 10..1* |
| Type | HumanName |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 298. Bundle.entry:practitioner.resource.name.use | |
| Definition | Identifies the purpose for this name. |
| Short | usual | official | temp | nickname | anonymous | old | maiden |
| Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/name-use|5.0.0)The use of a human name. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 300. Bundle.entry:practitioner.resource.name.text | |
| Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. |
| Short | Text representation of the full name |
| Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
| Control | 0..01 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | A renderable, unencoded form. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 302. Bundle.entry:practitioner.resource.name.period | |
| Definition | Indicates the period of time when this name was valid for the named person. |
| Short | Time period when name was/is in use |
| Control | 0..01 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows names to be placed in historical context. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 304. Bundle.entry:practitioner.resource.deceased[x] | |
| Definition | Indicates if the practitioner is deceased or not. |
| Short | Indicates if the practitioner is deceased or not |
| Comments | If there's no value in the instance, it means there is no statement on whether or not the practitioner is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. |
| Control | 0..01 |
| Type | Choice of: boolean, dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 306. Bundle.entry:practitioner.resource.photo | |
| Definition | Image of the person. |
| Short | Image of the person |
| Control | 0..0* |
| Type | Attachment |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 308. Bundle.entry:practitioner.resource.qualification | |
| Definition | The official qualifications, certifications, accreditations, training, licenses (and other types of educations/skills/capabilities) that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board of licensure authorizing the practitioner to practice medicine within a certain locality. |
| Short | Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care |
| Comments | The PractitionerRole.specialty defines the functional role that they are practicing at a given organization or location. Those specialties may or might not require a qualification, and are not defined on the practitioner. |
| Control | 0..0* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 312. Bundle.entry:practitioner.resource.communication | |
| Definition | A language which may be used to communicate with the practitioner, often for correspondence/administrative purposes. The |
| Short | A language which may be used to communicate with the practitioner |
| Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Practitioner.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. |
| Control | 0..0* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 316. Bundle.entry:practitioner.search | |
| Definition | Information about the search process that lead to the creation of this entry. |
| Short | Search related information |
| Control | 0..01 This element is affected by the following invariants: bdl-2 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 319. Bundle.entry:practitioner.request | |
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. |
| Short | Additional execution information (transaction/batch/history) |
| Control | 10..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 321. Bundle.entry:practitioner.request.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 323. Bundle.entry:practitioner.request.method | |
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. |
| Short | GET | HEAD | POST | PUT | DELETE | PATCH |
| Control | 1..1 This element is affected by the following invariants: bdl-3b, bdl-3c, bdl-14, bdl-15 |
| Binding | The codes SHALL be taken from HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 (required to http://hl7.org/fhir/ValueSet/http-verb|5.0.0)HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 325. Bundle.entry:practitioner.request.url | |
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). |
| Short | URL for HTTP equivalent of this entry |
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 327. Bundle.entry:practitioner.request.ifNoneExist | |
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). |
| Short | For conditional creates |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ifnoneexist-on-identifier: ifNoneExist must key on the resource's external (secondary) or internal (usual) identifier, and must include a system: identifier=<system>|<value> ( $this.matches('^identifier=[^|]+\|[^|]+$')) |
| 329. Bundle.entry:practitioner.response | |
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. |
| Short | Results of execution (transaction/batch/history) |
| Control | 0..01 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3d, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 333. Bundle.entry:specimen | |
| Slice Name | specimen |
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | Entry in the bundle - will have a resource or information |
| Control | 10..1* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists()) bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 335. Bundle.entry:specimen.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 337. Bundle.entry:specimen.fullUrl | |
| Definition | The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
|
| Short | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). |
| Control | 10..1 This element is affected by the following invariants: bdl-7, bdl-15, bdl-8 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) urn-uuid: fullUrl must be a urn:uuid: reference for POST transaction entries ( matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')) |
| 339. Bundle.entry:specimen.resource | |
| Definition | A sample to be used for analysis. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning. |
| Short | Sample for analysisA resource in the bundle |
| Control | 10..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 |
| Type | SpecimenResource(SenaiteSpecimen |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | no-internal-id-on-create: The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create (identifier.where(use = 'usual').empty())no-barcode-on-create: The barcode label (SenaiteSpecimenBarcode) is generated by SENAITE and must not be supplied on an external create ( extension.where(url = 'https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode').empty()) |
| 341. Bundle.entry:specimen.resource.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| 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. |
| Control | 0..01 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 343. Bundle.entry:specimen.resource.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 | A set of rules under which this content was created |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 345. Bundle.entry:specimen.resource.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 | Contained, inline 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. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 347. Bundle.entry:specimen.resource.extension:barcode | |
| Slice Name | barcode |
| Definition | The barcode label for the specimen container, generated by SENAITE. It encodes the Sample ID by default, or the Client Sample ID where the deployment is configured to use it. SHALL be present on every Specimen returned by SENAITE. SHALL NOT be supplied by a consumer: a SenaiteRequestBundle whose Specimen entry carries it is rejected. |
| Short | Barcode label (base64 PDF or image) — SHALL be present when returned by SENAITE; SHALL NOT be supplied on create |
| Control | 0..1 |
| Type | Extension(SENAITE Specimen Barcode) (Extension Type: Attachment) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | 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()) |
| 349. Bundle.entry:specimen.resource.modifierExtension | |
| Definition | An Extension 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 | ExtensionExtensions that cannot be ignored |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 351. Bundle.entry:specimen.resource.identifier | |
| Definition | Id for specimen. |
| Short | External Identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
|
| 353. Bundle.entry:specimen.resource.identifier:senaiteId | |
| Slice Name | senaiteId |
| Definition | The SENAITE sample Object ID. Human readable and generated by SENAITE when the Sample is created, and shared between the Specimen and DiagnosticReport, which hold the same value. This identifier tracks the specimen throughout its processing lifecycle in the laboratory. It must not be supplied by a client on an external create — a POST entry carrying it is rejected. Once assigned it may be used to identify the Specimen on reads and subsequent updates. Id for specimen. |
| Short | Internal SENAITE Sample ID — matches the DiagnosticReport usual identifierExternal Identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 355. Bundle.entry:specimen.resource.identifier:senaiteId.extension | |
| Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 357. Bundle.entry:specimen.resource.identifier:senaiteId.use | |
| Definition | The purpose of this identifier. |
| Short | usualusual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 359. Bundle.entry:specimen.resource.identifier:senaiteId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..01 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0 (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 361. Bundle.entry:specimen.resource.identifier:senaiteId.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | Sample ID namespace — mandatory and fixed by this IGThe namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 10..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Fixed Value | |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 363. Bundle.entry:specimen.resource.identifier:senaiteId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | Internal SENAITE sample identifier — alphanumeric and hyphens onlyThe value that is unique |
| 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. |
| Control | 10..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 365. Bundle.entry:specimen.resource.identifier:senaiteId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..01 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 367. Bundle.entry:specimen.resource.identifier:senaiteId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..01 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 369. Bundle.entry:specimen.resource.identifier:clientSampleId | |
| Slice Name | clientSampleId |
| Definition | The Client Sample ID: a consumer-owned business identifier for the Sample, assigned outside SENAITE (e.g. by a laboratory information system or an EHR order number). Unlike the internal ID this may be supplied on create, on the Specimen entry of a SenaiteRequestBundle, or entered against the Sample by laboratory staff in the web application. SENAITE preserves the value as-is. Where the deployment is configured to do so, it is the value encoded in the specimen container barcode in place of the Sample ID. The same value appears on the corresponding DiagnosticReport. Id for specimen. |
| Short | External Client Sample ID assigned by the consumer's system — may be supplied on createExternal Identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 371. Bundle.entry:specimen.resource.identifier:clientSampleId.extension | |
| Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 373. Bundle.entry:specimen.resource.identifier:clientSampleId.use | |
| Definition | The purpose of this identifier. |
| Short | secondaryusual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 375. Bundle.entry:specimen.resource.identifier:clientSampleId.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | Client Sample ID namespace — mandatory and fixed by this IGThe namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 10..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Fixed Value | |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 377. Bundle.entry:specimen.resource.identifier:clientSampleId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | Client Sample ID — alphanumeric and hyphens onlyThe value that is unique |
| 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. |
| Control | 10..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 379. Bundle.entry:specimen.resource.identifier:clientSampleId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..01 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 381. Bundle.entry:specimen.resource.identifier:clientSampleId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..01 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 383. Bundle.entry:specimen.resource.accessionIdentifier | |
| 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. |
| Short | Identifier assigned by the lab |
| Control | 0..01 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 385. Bundle.entry:specimen.resource.status | |
| Definition | The availability of the specimen. |
| Short | available | unavailable | unsatisfactory | entered-in-error |
| Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|5.0.0 (required to http://hl7.org/fhir/ValueSet/specimen-status|5.0.0)Codes providing the status/availability of a specimen. |
| Type | code |
| Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 387. Bundle.entry:specimen.resource.type | |
| Definition | The kind of material that forms the specimen. |
| Short | Kind of material that forms the specimen |
| 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. |
| Control | 10..1 |
| Binding | For example codes, see hl7VS-specimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 (example to http://terminology.hl7.org/ValueSet/v2-0487)The type of the specimen. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 389. Bundle.entry:specimen.resource.type.extension | |
| Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.type.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 391. Bundle.entry:specimen.resource.type.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Short | Code defined by a terminology system |
| 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. |
| Control | 10..1* |
| Binding | The codes SHOULD be taken from For codes, see http://snomed.info/sct (preferred to http://snomed.info/sct) |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 393. Bundle.entry:specimen.resource.type.coding.extension | |
| Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.type.coding.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 395. Bundle.entry:specimen.resource.type.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 | Version of the system - if relevant |
| 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. |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..01 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 397. Bundle.entry:specimen.resource.type.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 | If this coding was chosen directly by the user |
| 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. |
| Control | 0..01 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 399. Bundle.entry:specimen.resource.subject | |
| 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, a biologically-derived product, or a device. |
| Short | 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, a biologically-derived product, or a device |
| Control | 0..01 |
| Type | Reference(Patient, Group, Device, BiologicallyDerivedProduct, Substance, Location) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Must know the subject context. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 401. Bundle.entry:specimen.resource.receivedTime | |
| Definition | Time when specimen is received by the testing laboratory for processing or testing. |
| Short | The time when specimen is received by the testing laboratory |
| Control | 0..01 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 403. Bundle.entry:specimen.resource.parent | |
| Definition | Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. |
| Short | Specimen from which this specimen originated |
| 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. |
| Control | 0..0* |
| Type | Reference(Specimen) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 405. Bundle.entry:specimen.resource.request | |
| Definition | Details concerning a service request that required a specimen to be collected. |
| Short | Why the specimen was collected |
| Comments | The request may be explicit or implied such with a ServiceRequest that requires a blood draw. |
| Control | 0..0* |
| Type | Reference(ServiceRequest) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 407. Bundle.entry:specimen.resource.combined | |
| Definition | This element signifies if the specimen is part of a group or pooled. |
| Short | grouped | pooled |
| Control | 0..01 |
| Binding | The codes SHALL be taken from SpecimenCombinedhttp://hl7.org/fhir/ValueSet/specimen-combined|5.0.0 (required to http://hl7.org/fhir/ValueSet/specimen-combined|5.0.0)Codes for the combined status of a specimen. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 409. Bundle.entry:specimen.resource.role | |
| Definition | The role or reason for the specimen in the testing workflow. |
| Short | The role the specimen serves |
| Control | 0..0* |
| Binding | The codes SHOULD be taken from SpecimenRolehttp://hl7.org/fhir/ValueSet/specimen-role|5.0.0 (preferred to http://hl7.org/fhir/ValueSet/specimen-role|5.0.0)Codes describing specimen role. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 411. Bundle.entry:specimen.resource.feature | |
| Definition | A physical feature or landmark on a specimen, highlighted for context by the collector of the specimen (e.g. surgeon), that identifies the type of feature as well as its meaning (e.g. the red ink indicating the resection margin of the right lobe of the excised prostate tissue or wire loop at radiologically suspected tumor location). |
| Short | The physical feature of a specimen |
| Control | 0..0* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 416. Bundle.entry:specimen.resource.collection | |
| Definition | Details concerning the specimen collection. |
| Short | Collection details |
| Control | 10..1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 418. Bundle.entry:specimen.resource.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 420. Bundle.entry:specimen.resource.collection.duration | |
| Definition | The span of time over which the collection of a specimen occurred. |
| Short | How long it took to collect specimen |
| Control | 0..01 |
| Type | Duration |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 422. Bundle.entry:specimen.resource.collection.quantity | |
| Definition | The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. |
| Short | The quantity of specimen collected |
| Control | 0..01 |
| Type | Quantity(SimpleQuantity) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty()) |
| 424. Bundle.entry:specimen.resource.collection.method | |
| Definition | A coded value specifying the technique that is used to perform the procedure. |
| Short | Technique used to perform collection |
| Control | 0..01 |
| Binding | For example codes, see FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-method|5.0.0 (example to http://hl7.org/fhir/ValueSet/specimen-collection-method|5.0.0)The technique that is used to perform the procedure. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 426. Bundle.entry:specimen.resource.collection.fastingStatus[x] | |
| Definition | Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection. |
| Short | Whether or how long patient abstained from food and/or drink |
| 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 |
| Control | 0..01 |
| Binding | Unless not suitable, these codes SHALL be taken from hl7VS-relevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 (extensible to http://terminology.hl7.org/ValueSet/v2-0916)Codes describing the fasting status of the patient. |
| Type | Choice of: CodeableConcept, Duration |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Many diagnostic tests require fasting to facilitate accurate interpretation. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 428. Bundle.entry:specimen.resource.processing | |
| Definition | Details concerning processing and processing steps for the specimen. |
| Short | Processing and processing step details |
| Control | 0..0* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 431. Bundle.entry:specimen.resource.container | |
| Definition | The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here. |
| Short | Direct container of specimen (tube/slide, etc.) |
| Control | 0..0* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 435. Bundle.entry:specimen.resource.condition | |
| Definition | A mode or state of being that describes the nature of the specimen. |
| Short | State of the specimen |
| 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. |
| Control | 0..0* |
| Binding | Unless not suitable, these codes SHALL be taken from hl7VS-specimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 (extensible to http://terminology.hl7.org/ValueSet/v2-0493)Codes describing the state of the specimen. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | The specimen condition can be used to assess its quality or appropriateness for a specific test. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 437. Bundle.entry:specimen.search | |
| Definition | Information about the search process that lead to the creation of this entry. |
| Short | Search related information |
| Control | 0..01 This element is affected by the following invariants: bdl-2 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 440. Bundle.entry:specimen.request | |
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. |
| Short | Additional execution information (transaction/batch/history) |
| Control | 10..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 442. Bundle.entry:specimen.request.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 444. Bundle.entry:specimen.request.method | |
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. |
| Short | GET | HEAD | POST | PUT | DELETE | PATCH |
| Control | 1..1 This element is affected by the following invariants: bdl-3b, bdl-3c, bdl-14, bdl-15 |
| Binding | The codes SHALL be taken from HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 (required to http://hl7.org/fhir/ValueSet/http-verb|5.0.0)HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 446. Bundle.entry:specimen.request.url | |
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). |
| Short | URL for HTTP equivalent of this entry |
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 448. Bundle.entry:specimen.request.ifNoneExist | |
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). |
| Short | For conditional creates |
| Control | 0..01 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 450. Bundle.entry:specimen.response | |
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. |
| Short | Results of execution (transaction/batch/history) |
| Control | 0..01 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3d, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 454. Bundle.entry:organization | |
| Slice Name | organization |
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | Entry in the bundle - will have a resource or information |
| Control | 0..1* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists()) bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 456. Bundle.entry:organization.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 458. Bundle.entry:organization.fullUrl | |
| Definition | The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
|
| Short | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). |
| Control | 10..1 This element is affected by the following invariants: bdl-7, bdl-15, bdl-8 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) urn-uuid: fullUrl must be a urn:uuid: reference for POST transaction entries ( matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')) |
| 460. Bundle.entry:organization.resource | |
| Definition | A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning. |
| Short | A grouping of people or organizations with a common purposeA resource in the bundle |
| Control | 10..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 |
| Type | OrganizationResource(SenaiteOrganization |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | no-internal-id-on-create: The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create (identifier.where(use = 'usual').empty()) |
| 462. Bundle.entry:organization.resource.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| 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. |
| Control | 0..01 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 464. Bundle.entry:organization.resource.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 | A set of rules under which this content was created |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 466. Bundle.entry:organization.resource.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 | Contained, inline 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. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 468. Bundle.entry:organization.resource.modifierExtension | |
| Definition | An Extension 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 | ExtensionExtensions that cannot be ignored |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 470. Bundle.entry:organization.resource.identifier | |
| Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. |
| Short | Identifies this organization across multiple systems |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* This element is affected by the following invariants: org-1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
|
| 472. Bundle.entry:organization.resource.identifier:senaiteId | |
| Slice Name | senaiteId |
| Definition | The internal SENAITE Client ID. Human readable and generated by SENAITE when the Client Organisation is created. It must not be supplied by a client on an external create — a POST entry carrying it is rejected. Once assigned it may be used to identify the Organization on reads, on subsequent updates, and in Bundle.entry.request.ifNoneExist. Identifier for the organization that is used to identify the organization across multiple disparate systems. |
| Short | Internal SENAITE Client ID — server-assigned, do not include on createIdentifies this organization across multiple systems |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1* This element is affected by the following invariants: org-1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 474. Bundle.entry:organization.resource.identifier:senaiteId.extension | |
| Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 476. Bundle.entry:organization.resource.identifier:senaiteId.use | |
| Definition | The purpose of this identifier. |
| Short | usualusual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 478. Bundle.entry:organization.resource.identifier:senaiteId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..01 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0 (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 480. Bundle.entry:organization.resource.identifier:senaiteId.system | |
| Definition | The namespace for the internal SENAITE Client ID. Mandatory. Configurable per deployment; where a deployment has not defined its own URI, use the default https://fhir.senaite.org/NamingSystem/organization-id declared by SenaiteOrganizationIdNamingSystem. Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | Internal Organization ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/organization-idThe namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 10..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 482. Bundle.entry:organization.resource.identifier:senaiteId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | Internal SENAITE client identifier — alphanumeric and hyphens onlyThe value that is unique |
| 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. |
| Control | 10..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 484. Bundle.entry:organization.resource.identifier:senaiteId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..01 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 486. Bundle.entry:organization.resource.identifier:senaiteId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..01 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 488. Bundle.entry:organization.resource.identifier:externalId | |
| Slice Name | externalId |
| Definition | The consumer-owned business identifier for the organisation, for example a national organisation ID or an internal client code, originating in the API consumer's system. Unlike the internal ID this may be supplied on create, and is preserved as-is by SENAITE. Identifier for the organization that is used to identify the organization across multiple disparate systems. |
| Short | External Organization ID from the consumer's system — may be supplied on createIdentifies this organization across multiple systems |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1* This element is affected by the following invariants: org-1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 490. Bundle.entry:organization.resource.identifier:externalId.extension | |
| Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 492. Bundle.entry:organization.resource.identifier:externalId.use | |
| Definition | The purpose of this identifier. |
| Short | secondaryusual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 494. Bundle.entry:organization.resource.identifier:externalId.system | |
| Definition | The namespace for the consumer's own organisation identifier. Mandatory. Normally the URI of the consumer's organisation registry, agreed at integration time; where the consumer or deployment has none, use the default https://fhir.senaite.org/NamingSystem/organization-external-id declared by SenaiteOrganizationExternalIdNamingSystem. A system is required because request.ifNoneExist and the identifier search parameter match on system and value and ignore Identifier.use. Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | External Organization ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/organization-external-idThe namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 10..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 496. Bundle.entry:organization.resource.identifier:externalId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | External organisation identifier — alphanumeric and hyphens onlyThe value that is unique |
| 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. |
| Control | 10..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 498. Bundle.entry:organization.resource.identifier:externalId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..01 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 500. Bundle.entry:organization.resource.identifier:externalId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..01 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 502. Bundle.entry:organization.resource.active | |
| Definition | Whether the organization's record is still in active use. |
| Short | Whether the organization's record is still in active use |
| Comments | This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. |
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 504. Bundle.entry:organization.resource.type | |
| Definition | The kind(s) of organization that this is. |
| Short | Kind of organization |
| Comments | Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. |
| Control | 0..0* |
| Binding | For example codes, see OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-type|5.0.0 (example to http://hl7.org/fhir/ValueSet/organization-type|5.0.0)Used to categorize the organization. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 506. Bundle.entry:organization.resource.name | |
| Definition | A name associated with the organization. |
| Short | Name used for the organization |
| Comments | If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. |
| Control | 10..1 This element is affected by the following invariants: org-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Need to use the name as the label of the organization. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 508. Bundle.entry:organization.resource.alias | |
| Definition | A list of alternate names that the organization is known as, or was known as in the past. |
| Short | A list of alternate names that the organization is known as, or was known as in the past |
| Comments | There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization. |
| Control | 0..0* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 510. Bundle.entry:organization.resource.description | |
| Definition | Description of the organization, which helps provide additional general context on the organization to ensure that the correct organization is selected. |
| Short | Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name |
| Control | 0..01 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Humans need additional information to verify a correct Organization has been selected. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 512. Bundle.entry:organization.resource.endpoint | |
| Definition | Technical endpoints providing access to services operated for the organization. |
| Short | Technical endpoints providing access to services operated for the organization |
| Control | 0..0* |
| Type | Reference(Endpoint) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 514. Bundle.entry:organization.resource.qualification | |
| Definition | The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization. For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization. |
| Short | Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care |
| Control | 0..0* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 518. Bundle.entry:organization.search | |
| Definition | Information about the search process that lead to the creation of this entry. |
| Short | Search related information |
| Control | 0..01 This element is affected by the following invariants: bdl-2 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 521. Bundle.entry:organization.request | |
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. |
| Short | Additional execution information (transaction/batch/history) |
| Control | 10..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 523. Bundle.entry:organization.request.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 525. Bundle.entry:organization.request.method | |
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. |
| Short | GET | HEAD | POST | PUT | DELETE | PATCH |
| Control | 1..1 This element is affected by the following invariants: bdl-3b, bdl-3c, bdl-14, bdl-15 |
| Binding | The codes SHALL be taken from HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 (required to http://hl7.org/fhir/ValueSet/http-verb|5.0.0)HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 527. Bundle.entry:organization.request.url | |
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). |
| Short | URL for HTTP equivalent of this entry |
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 529. Bundle.entry:organization.request.ifNoneExist | |
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). |
| Short | For conditional creates |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ifnoneexist-on-identifier: ifNoneExist must key on the resource's external (secondary) or internal (usual) identifier, and must include a system: identifier=<system>|<value> ( $this.matches('^identifier=[^|]+\|[^|]+$')) |
| 531. Bundle.entry:organization.response | |
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. |
| Short | Results of execution (transaction/batch/history) |
| Control | 0..01 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3d, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 535. Bundle.signature | |
| Definition | Digital Signature - base64 encoded. XML-DSig or a JWS. |
| Short | Digital Signature |
| Comments | The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific. |
| Control | 0..01 |
| Type | Signature |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 537. Bundle.issues | |
| Definition | Captures issues and warnings that relate to the construction of the Bundle and the content within it. |
| Short | Issues with the Bundle |
| Comments | Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle. |
| Control | 0..1 This element is affected by the following invariants: bdl-16, bdl-17 |
| Type | Resource(OperationOutcome |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
See the documentation on how to interpret the contents of this table
| 0. Bundle | |
| 2. Bundle.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..0 |
| 4. Bundle.type | |
| Fixed Value | |
| 6. Bundle.timestamp | |
| Control | 0..0 |
| 8. Bundle.total | |
| Control | 0..0 |
| 10. Bundle.link | |
| Control | 0..0 |
| 12. Bundle.entry | |
| Control | 2..? |
| Slicing | This element introduces a set of slices on Bundle.entry. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
|
| 14. Bundle.entry:serviceRequest | |
| Slice Name | serviceRequest |
| Control | 1..1 |
| 16. Bundle.entry:serviceRequest.fullUrl | |
| Control | 1..? |
| Invariants | urn-uuid: fullUrl must be a urn:uuid: reference for POST transaction entries (matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')) |
| 18. Bundle.entry:serviceRequest.resource | |
| Control | 1..? |
| Type | ServiceRequest(SENAITE Service Request) |
| 20. Bundle.entry:serviceRequest.resource.id | |
| Control | 0..0 |
| 22. Bundle.entry:serviceRequest.search | |
| Control | 0..0 |
| 24. Bundle.entry:serviceRequest.request | |
| Control | 1..? |
| 26. Bundle.entry:serviceRequest.request.method | |
| Fixed Value | |
| 28. Bundle.entry:serviceRequest.request.url | |
| Fixed Value | |
| 30. Bundle.entry:serviceRequest.request.ifNoneExist | |
| Control | 0..0 |
| 32. Bundle.entry:serviceRequest.response | |
| Control | 0..0 |
| 34. Bundle.entry:patient | |
| Slice Name | patient |
| Control | 0..1 |
| 36. Bundle.entry:patient.fullUrl | |
| Control | 1..? |
| Invariants | urn-uuid: fullUrl must be a urn:uuid: reference for POST transaction entries (matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')) |
| 38. Bundle.entry:patient.resource | |
| Control | 1..? |
| Type | Patient(SenaitePatient) |
| Invariants | no-internal-id-on-create: The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create (identifier.where(use = 'usual').empty()) |
| 40. Bundle.entry:patient.resource.id | |
| Control | 0..0 |
| 42. Bundle.entry:patient.search | |
| Control | 0..0 |
| 44. Bundle.entry:patient.request | |
| Control | 1..? |
| 46. Bundle.entry:patient.request.method | |
| Fixed Value | |
| 48. Bundle.entry:patient.request.url | |
| Fixed Value | |
| 50. Bundle.entry:patient.request.ifNoneExist | |
| Invariants | ifnoneexist-on-identifier: ifNoneExist must key on the resource's external (secondary) or internal (usual) identifier, and must include a system: identifier=<system>|<value> ($this.matches('^identifier=[^|]+\|[^|]+$')) |
| 52. Bundle.entry:patient.response | |
| Control | 0..0 |
| 54. Bundle.entry:practitioner | |
| Slice Name | practitioner |
| Control | 0..1 |
| 56. Bundle.entry:practitioner.fullUrl | |
| Control | 1..? |
| Invariants | urn-uuid: fullUrl must be a urn:uuid: reference for POST transaction entries (matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')) |
| 58. Bundle.entry:practitioner.resource | |
| Control | 1..? |
| Type | Practitioner(SenaitePractitioner) |
| Invariants | no-internal-id-on-create: The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create (identifier.where(use = 'usual').empty()) |
| 60. Bundle.entry:practitioner.resource.id | |
| Control | 0..0 |
| 62. Bundle.entry:practitioner.search | |
| Control | 0..0 |
| 64. Bundle.entry:practitioner.request | |
| Control | 1..? |
| 66. Bundle.entry:practitioner.request.method | |
| Fixed Value | |
| 68. Bundle.entry:practitioner.request.url | |
| Fixed Value | |
| 70. Bundle.entry:practitioner.request.ifNoneExist | |
| Invariants | ifnoneexist-on-identifier: ifNoneExist must key on the resource's external (secondary) or internal (usual) identifier, and must include a system: identifier=<system>|<value> ($this.matches('^identifier=[^|]+\|[^|]+$')) |
| 72. Bundle.entry:practitioner.response | |
| Control | 0..0 |
| 74. Bundle.entry:specimen | |
| Slice Name | specimen |
| Control | 1..1 |
| 76. Bundle.entry:specimen.fullUrl | |
| Control | 1..? |
| Invariants | urn-uuid: fullUrl must be a urn:uuid: reference for POST transaction entries (matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')) |
| 78. Bundle.entry:specimen.resource | |
| Control | 1..? |
| Type | Specimen(SenaiteSpecimen) |
| Invariants | no-internal-id-on-create: The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create (identifier.where(use = 'usual').empty())no-barcode-on-create: The barcode label (SenaiteSpecimenBarcode) is generated by SENAITE and must not be supplied on an external create ( extension.where(url = 'https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode').empty()) |
| 80. Bundle.entry:specimen.resource.id | |
| Control | 0..0 |
| 82. Bundle.entry:specimen.search | |
| Control | 0..0 |
| 84. Bundle.entry:specimen.request | |
| Control | 1..? |
| 86. Bundle.entry:specimen.request.method | |
| Fixed Value | |
| 88. Bundle.entry:specimen.request.url | |
| Fixed Value | |
| 90. Bundle.entry:specimen.request.ifNoneExist | |
| Control | 0..0 |
| 92. Bundle.entry:specimen.response | |
| Control | 0..0 |
| 94. Bundle.entry:organization | |
| Slice Name | organization |
| Control | 0..1 |
| 96. Bundle.entry:organization.fullUrl | |
| Control | 1..? |
| Invariants | urn-uuid: fullUrl must be a urn:uuid: reference for POST transaction entries (matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')) |
| 98. Bundle.entry:organization.resource | |
| Control | 1..? |
| Type | Organization(SenaiteOrganization) |
| Invariants | no-internal-id-on-create: The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create (identifier.where(use = 'usual').empty()) |
| 100. Bundle.entry:organization.resource.id | |
| Control | 0..0 |
| 102. Bundle.entry:organization.search | |
| Control | 0..0 |
| 104. Bundle.entry:organization.request | |
| Control | 1..? |
| 106. Bundle.entry:organization.request.method | |
| Fixed Value | |
| 108. Bundle.entry:organization.request.url | |
| Fixed Value | |
| 110. Bundle.entry:organization.request.ifNoneExist | |
| Invariants | ifnoneexist-on-identifier: ifNoneExist must key on the resource's external (secondary) or internal (usual) identifier, and must include a system: identifier=<system>|<value> ($this.matches('^identifier=[^|]+\|[^|]+$')) |
| 112. Bundle.entry:organization.response | |
| Control | 0..0 |
| 114. Bundle.signature | |
| Control | 0..0 |
See the documentation on how to interpret the contents of this table
| 0. Bundle | |
| Definition | A container for a collection of resources. |
| Short | Contains a collection of resources |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | bdl-1: total only when a search or history (total.empty() or (type = 'searchset') or (type = 'history'))bdl-2: entry.search only when a search ( (type = 'searchset') or entry.search.empty())bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) ( (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct())bdl-9: A document must have an identifier with a system and a value ( type = 'document' implies (identifier.system.exists() and identifier.value.exists()))bdl-10: A document must have a date ( type = 'document' implies (timestamp.hasValue()))bdl-11: A document must have a Composition as the first resource ( type = 'document' implies entry.first().resource.is(Composition))bdl-12: A message must have a MessageHeader as the first resource ( type = 'message' implies entry.first().resource.is(MessageHeader))bdl-13: A subscription-notification must have a SubscriptionStatus as the first resource ( type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus))bdl-14: entry.request.method PATCH not allowed for history ( type = 'history' implies entry.request.method != 'PATCH')bdl-15: Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated ( type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST'))bdl-16: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. ( issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning'))bdl-17: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. ( type = 'document' implies issues.empty())bdl-18: Self link is required for searchsets. ( type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists())bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements ( type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty()))bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH ( type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists())))bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH ( type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists())))bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements ( type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())) |
| 2. Bundle.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| 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. |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 4. Bundle.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 | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. Bundle.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 | A set of rules under which this content was created |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. Bundle.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| 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). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Bundle.identifier | |
| Definition | A persistent identifier for the bundle that won't change as a bundle is copied from server to server. |
| Short | Persistent identifier for the bundle |
| Comments | Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..0 This element is affected by the following invariants: bdl-9 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. Bundle.type | |
| Definition | Indicates the purpose of this bundle - how it is intended to be used. |
| Short | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification |
| Comments | It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. |
| Control | 1..1 This element is affected by the following invariants: bdl-1, bdl-2, bdl-3a, bdl-3b, bdl-3c, bdl-3d, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-17, bdl-18 |
| Binding | The codes SHALL be taken from BundleType (required to http://hl7.org/fhir/ValueSet/bundle-type|5.0.0)Indicates the purpose of a bundle - how it is intended to be used. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. Bundle.timestamp | |
| Definition | The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. |
| Short | When the bundle was assembled |
| Comments | For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated. Usage:
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself. |
| Control | 0..0 This element is affected by the following invariants: bdl-10 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. Bundle.total | |
| Definition | If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. |
| Short | If search, the total number of matches |
| Comments | Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources. |
| Control | 0..0 This element is affected by the following invariants: bdl-1 |
| Type | unsignedInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. Bundle.link | |
| Definition | A series of links that provide context to this bundle. |
| Short | Links related to this Bundle |
| Comments | Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS). Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly. This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners. |
| Control | 0..0 This element is affected by the following invariants: bdl-18 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 25. Bundle.entry | |
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | Entry in the bundle - will have a resource or information |
| Control | 2..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())bdl-8: fullUrl cannot be a version specific reference ( fullUrl.exists() implies fullUrl.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Bundle.entry. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
|
| 27. Bundle.entry.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 29. Bundle.entry.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 31. Bundle.entry.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 33. Bundle.entry.link | |
| Definition | A series of links that provide context to this entry. |
| Short | Links related to this entry |
| Control | 0..* |
| Type | Seettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 35. Bundle.entry.fullUrl | |
| Definition | The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
|
| Short | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). |
| Control | 0..1 This element is affected by the following invariants: bdl-7, bdl-15, bdl-8 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 37. Bundle.entry.resource | |
| Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning. |
| Short | A resource in the bundle |
| Control | 0..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 39. Bundle.entry.search | |
| Definition | Information about the search process that lead to the creation of this entry. |
| Short | Search related information |
| Control | 0..1 This element is affected by the following invariants: bdl-2 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 41. Bundle.entry.search.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 43. Bundle.entry.search.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 45. Bundle.entry.search.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 47. Bundle.entry.search.mode | |
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
| Short | match | include - why this is in the result set |
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from SearchEntryMode (required to http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0)Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 49. Bundle.entry.search.score | |
| Definition | When searching, the server's search ranking score for the entry. |
| Short | Search ranking (between 0 and 1) |
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. |
| Control | 0..1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 51. Bundle.entry.request | |
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. |
| Short | Additional execution information (transaction/batch/history) |
| Control | 0..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 53. Bundle.entry.request.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 55. Bundle.entry.request.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 57. Bundle.entry.request.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 59. Bundle.entry.request.method | |
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. |
| Short | GET | HEAD | POST | PUT | DELETE | PATCH |
| Control | 1..1 This element is affected by the following invariants: bdl-3b, bdl-3c, bdl-14, bdl-15 |
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|5.0.0)HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 61. Bundle.entry.request.url | |
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). |
| Short | URL for HTTP equivalent of this entry |
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 63. Bundle.entry.request.ifNoneMatch | |
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". |
| Short | For managing cache validation |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 65. Bundle.entry.request.ifModifiedSince | |
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". |
| Short | For managing cache currency |
| Control | 0..1 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 67. Bundle.entry.request.ifMatch | |
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". |
| Short | For managing update contention |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 69. Bundle.entry.request.ifNoneExist | |
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). |
| Short | For conditional creates |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 71. Bundle.entry.response | |
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. |
| Short | Results of execution (transaction/batch/history) |
| Control | 0..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3d, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 73. Bundle.entry.response.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 75. Bundle.entry.response.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 77. Bundle.entry.response.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 79. Bundle.entry.response.status | |
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. |
| Short | Status response code (text optional) |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 81. Bundle.entry.response.location | |
| Definition | The location header created by processing this operation, populated if the operation returns a location. |
| Short | The location (if the operation returns a location) |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 83. Bundle.entry.response.etag | |
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). |
| Short | The Etag for the resource (if relevant) |
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 85. Bundle.entry.response.lastModified | |
| Definition | The date/time that the resource was modified on the server. |
| Short | Server's date time modified |
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. |
| Control | 0..1 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 87. Bundle.entry.response.outcome | |
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. |
| Short | OperationOutcome with hints and warnings (for batch/transaction) |
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. |
| Control | 0..1 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 89. Bundle.entry:serviceRequest | |
| Slice Name | serviceRequest |
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | Entry in the bundle - will have a resource or information |
| Control | 1..1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())bdl-8: fullUrl cannot be a version specific reference ( fullUrl.exists() implies fullUrl.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) |
| 91. Bundle.entry:serviceRequest.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 93. Bundle.entry:serviceRequest.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 95. Bundle.entry:serviceRequest.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 97. Bundle.entry:serviceRequest.link | |
| Definition | A series of links that provide context to this entry. |
| Short | Links related to this entry |
| Control | 0..* |
| Type | Seettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 99. Bundle.entry:serviceRequest.fullUrl | |
| Definition | The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
|
| Short | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). |
| Control | 1..1 This element is affected by the following invariants: bdl-7, bdl-15, bdl-8 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))urn-uuid: fullUrl must be a urn:uuid: reference for POST transaction entries ( matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')) |
| 101. Bundle.entry:serviceRequest.resource | |
| Definition | A record of a request for service such as diagnostic investigations, treatments, or operations to be performed. |
| Short | A request for a service to be performed |
| Control | 1..1 |
| Type | ServiceRequest(SENAITE Service Request |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | diagnostic request, referral, referral request, transfer of care request |
| 103. Bundle.entry:serviceRequest.resource.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| 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. |
| Control | 0..0 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 105. Bundle.entry:serviceRequest.resource.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 | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 107. Bundle.entry:serviceRequest.resource.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 | A set of rules under which this content was created |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 109. Bundle.entry:serviceRequest.resource.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| 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). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 111. Bundle.entry:serviceRequest.resource.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 | Text summary of the resource, for human interpretation |
| 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. |
| Control | 0..1 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | narrative, html, xhtml, display |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 113. Bundle.entry:serviceRequest.resource.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 | Contained, inline 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. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 115. Bundle.entry:serviceRequest.resource.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 1..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 117. Bundle.entry:serviceRequest.resource.extension:client | |
| Slice Name | client |
| Definition | A direct reference to the Organisation that is placing this laboratory request. In SENAITE this maps to the Client registered in the LIMS. If the client is not yet known, it will be created on receipt. |
| Short | The submitting client organisation |
| Control | 1..1 |
| Type | Extension(SENAITE Client) (Extension Type: Reference(SenaiteOrganization)) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | 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()) |
| 119. Bundle.entry:serviceRequest.resource.modifierExtension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Invariants | 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()) |
| 121. Bundle.entry:serviceRequest.resource.identifier | |
| Definition | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
| Short | Not used — see identifiers.html#sample-identifiers |
| Comments | The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 V2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 V2). For further discussion and examples see the resource notes section below. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..0 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 123. Bundle.entry:serviceRequest.resource.instantiatesCanonical | |
| Definition | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. |
| Short | Instantiates FHIR protocol or definition |
| Comments | The PlanDefinition resource is used to describe series, sequences, or groups of actions to be taken, while the ActivityDefinition resource is used to define each specific step or activity to be performed. More information can be found in the Boundaries and Relationships section for PlanDefinition. |
| Control | 0..0 |
| Type | canonical(ActivityDefinition, PlanDefinition) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 125. Bundle.entry:serviceRequest.resource.instantiatesUri | |
| Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. |
| Short | Instantiates external protocol or definition |
| Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. |
| Control | 0..0 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 127. Bundle.entry:serviceRequest.resource.basedOn | |
| Definition | Plan/proposal/order fulfilled by this request. |
| Short | What request fulfills |
| Control | 0..0 |
| Type | Reference(CarePlan, ServiceRequest, MedicationRequest) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | fulfills |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 129. Bundle.entry:serviceRequest.resource.replaces | |
| Definition | The request takes the place of the referenced completed or terminated request(s). |
| Short | What request replaces |
| Control | 0..0 |
| Type | Reference(ServiceRequest) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | supersedes, prior, renewed order |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 131. Bundle.entry:serviceRequest.resource.requisition | |
| Definition | The Sample Group ID: an identifier shared by all ServiceRequests belonging to the same order. The system is fixed to the Sample Group ID namespace; supply the same value on each ServiceRequest. The value is consumer-owned and must be unique within the consumer. It is a grouping label: SENAITE does not enforce that it is unique per sample and cannot know that an order is complete. There is no search by requisition on ServiceRequest; the combined report for a group is found by searching DiagnosticReport on the same value as an identifier. |
| Short | Order grouping identifier, shared by the ServiceRequests of one multi-tube order |
| Comments | Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation. |
| Control | 0..1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Some business processes need to know if multiple items were ordered as part of the same "requisition" for billing or other purposes. |
| Alternate Names | grouperId, groupIdentifier |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 133. Bundle.entry:serviceRequest.resource.requisition.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 135. Bundle.entry:serviceRequest.resource.requisition.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.requisition.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 137. Bundle.entry:serviceRequest.resource.requisition.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 139. Bundle.entry:serviceRequest.resource.requisition.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..0 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 141. Bundle.entry:serviceRequest.resource.requisition.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | The namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Fixed Value | |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 143. Bundle.entry:serviceRequest.resource.requisition.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | Requisition value — alphanumeric and hyphens only |
| 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. |
| Control | 1..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 145. Bundle.entry:serviceRequest.resource.requisition.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..0 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 147. Bundle.entry:serviceRequest.resource.requisition.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..0 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 149. Bundle.entry:serviceRequest.resource.status | |
| Definition | The status of the order. |
| Short | draft | active | on-hold | revoked | entered-in-error |
| Comments | The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, revoked or placed on-hold. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RequestStatus (required to http://hl7.org/fhir/ValueSet/request-status|5.0.0)The status of a service order. |
| Type | code |
| Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 151. Bundle.entry:serviceRequest.resource.intent | |
| Definition | Whether the request is a proposal, plan, an original order or a reflex order. |
| Short | order | reflex-order |
| Comments | This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RequestIntent (required to http://hl7.org/fhir/ValueSet/request-intent|5.0.0)The kind of service request. |
| Type | code |
| Is Modifier | true because This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 153. Bundle.entry:serviceRequest.resource.category | |
| Definition | This will always be a Laboratory procedure |
| Short | Classification of service |
| Comments | There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ServiceRequestCategoryCodes (required to http://hl7.org/fhir/ValueSet/servicerequest-category)Classification of the requested service. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Used for filtering what service request are retrieved and displayed. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 155. Bundle.entry:serviceRequest.resource.category.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 157. Bundle.entry:serviceRequest.resource.category.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.category.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 159. Bundle.entry:serviceRequest.resource.category.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Short | Code defined by a terminology system |
| 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. |
| Control | 0..* |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 161. Bundle.entry:serviceRequest.resource.category.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 163. Bundle.entry:serviceRequest.resource.category.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.category.coding.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 165. Bundle.entry:serviceRequest.resource.category.coding.system | |
| Definition | Always use SNOMED |
| Short | Identity of the terminology system |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 167. Bundle.entry:serviceRequest.resource.category.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 | Version of the system - if relevant |
| 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. |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..0 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 169. Bundle.entry:serviceRequest.resource.category.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 | Symbol in syntax defined by the system |
| Control | 0..1 This element is affected by the following invariants: cod-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need to refer to a particular code in the system. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 171. Bundle.entry:serviceRequest.resource.category.coding.display | |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Short | Representation defined by the system |
| Control | 0..1 This element is affected by the following invariants: cod-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 173. Bundle.entry:serviceRequest.resource.category.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 | If this coding was chosen directly by the user |
| 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. |
| Control | 0..0 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 175. Bundle.entry:serviceRequest.resource.category.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 | Plain text representation of the concept |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 177. Bundle.entry:serviceRequest.resource.priority | |
| Definition | Indicates how quickly the ServiceRequest should be addressed with respect to other requests. |
| Short | routine | urgent | asap | stat |
| Control | 0..1 |
| Binding | The codes SHALL be taken from RequestPriority (required to http://hl7.org/fhir/ValueSet/request-priority|5.0.0)Identifies the level of importance to be assigned to actioning the request. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Meaning if Missing | If missing, this task should be performed with normal priority |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 179. Bundle.entry:serviceRequest.resource.doNotPerform | |
| Definition | Set this to true if the record is saying that the service/procedure should NOT be performed. |
| Short | True if service/procedure should not be performed |
| Comments | In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation. |
| Control | 0..0 |
| Type | boolean |
| Is Modifier | true because If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Used for do not ambulate, do not elevate head of bed, do not flush NG tube, do not take blood pressure on a certain arm, etc. |
| Meaning if Missing | If missing, the request is a positive request e.g. "do perform" |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 181. Bundle.entry:serviceRequest.resource.code | |
| Definition | A code or reference that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested. |
| Short | What is being requested/ordered |
| Comments | Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code. |
| Control | 1..1 This element is affected by the following invariants: prr-1 |
| Binding | The codes SHOULD be taken from http://loinc.org (preferred to http://loinc.org)For laboratory codes |
| Type | CodeableReference(ActivityDefinition, PlanDefinition) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | service requested |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 183. Bundle.entry:serviceRequest.resource.code.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 185. Bundle.entry:serviceRequest.resource.code.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.code.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 187. Bundle.entry:serviceRequest.resource.code.concept | |
| Definition | A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology. |
| Short | Reference to a concept (by class) |
| Control | 0..1 |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 189. Bundle.entry:serviceRequest.resource.code.reference | |
| Definition | A reference to a resource the provides exact details about the information being referenced. |
| Short | Reference to a resource (by instance) |
| Control | 0..1 |
| Type | Reference |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 191. Bundle.entry:serviceRequest.resource.orderDetail | |
| Definition | Panel and orderDetail rules: The
$revoke response codes: Returns |
| Short | Additional order information |
| Comments | For information from the medical record intended to support the delivery of the requested services, use the |
| Control | 0..* This element is affected by the following invariants: prr-1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | detailed instructions |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 193. Bundle.entry:serviceRequest.resource.orderDetail.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 195. Bundle.entry:serviceRequest.resource.orderDetail.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| 197. Bundle.entry:serviceRequest.resource.orderDetail.modifierExtension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Invariants | 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()) |
| 199. Bundle.entry:serviceRequest.resource.orderDetail.parameterFocus | |
| Definition | Indicates the context of the order details by reference. |
| Short | The context of the order details by reference |
| Control | 0..0 |
| Type | CodeableReference(Device, DeviceDefinition, DeviceRequest, SupplyRequest, Medication, MedicationRequest, BiologicallyDerivedProduct, Substance) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 201. Bundle.entry:serviceRequest.resource.orderDetail.parameter | |
| Definition | The parameter details for the service being requested. |
| Short | The parameter details for the service being requested |
| Control | 1..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 203. Bundle.entry:serviceRequest.resource.orderDetail.parameter.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 205. Bundle.entry:serviceRequest.resource.orderDetail.parameter.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| 207. Bundle.entry:serviceRequest.resource.orderDetail.parameter.modifierExtension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Invariants | 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()) |
| 209. Bundle.entry:serviceRequest.resource.orderDetail.parameter.code | |
| Definition | A value representing the additional detail or instructions for the order (e.g., catheter insertion, body elevation, descriptive device configuration and/or setting instructions). |
| Short | The detail of the order being requested |
| Control | 1..1 |
| Binding | For example codes, see ServiceRequestOrderDetailParameterCode (example to http://hl7.org/fhir/ValueSet/servicerequest-orderdetail-parameter-code|5.0.0)Codes for order detail parameters. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Pattern Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 211. Bundle.entry:serviceRequest.resource.orderDetail.parameter.value[x] | |
| Definition | Indicates a value for the order detail. |
| Short | The value for the order detail |
| Comments | CodeableConcept values are indented to express concepts that would normally be coded - when a code is not available for a concept, CodeableConcept.text can be used. When the data is a text or not a single identifiable concept, string should be used. |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from http://loinc.org (preferred to http://loinc.org)LOINC codes for individual laboratory tests |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 213. Bundle.entry:serviceRequest.resource.quantity[x] | |
| Definition | An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction). |
| Short | Service amount |
| Control | 0..0 |
| Type | Choice of: Quantity, Ratio, Range |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | When ordering a service the number of service items may need to be specified separately from the the service item. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 215. Bundle.entry:serviceRequest.resource.subject | |
| Definition | On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans). |
| Short | Individual or Entity the service is ordered for |
| Control | 1..1 |
| Type | Reference(Patient, Group, Location, Device) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 217. Bundle.entry:serviceRequest.resource.subject.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 219. Bundle.entry:serviceRequest.resource.subject.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.subject.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 221. Bundle.entry:serviceRequest.resource.subject.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Control | 0..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))subject-identified: If there is no identifier then it must have a key ( hasValue() or subject.identifier.count()) |
| 223. Bundle.entry:serviceRequest.resource.subject.type | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Control | 0..0 |
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)Aa resource (or, for logical models, the URI of the logical model). |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 225. Bundle.entry:serviceRequest.resource.subject.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..0 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 227. Bundle.entry:serviceRequest.resource.subject.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Short | Text alternative for the resource |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 229. Bundle.entry:serviceRequest.resource.focus | |
| Definition | The actual focus of a service request when it is not the subject of record representing something or someone associated with the subject such as a spouse, parent, fetus, or donor. The focus of a service request could also be an existing condition, an intervention, the subject's diet, another service request on the subject, or a body structure such as tumor or implanted device. |
| Short | What the service request is about, when it is not about the subject of record |
| Control | 0..* |
| Type | Reference(Resource) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 231. Bundle.entry:serviceRequest.resource.encounter | |
| Definition | An encounter that provides additional information about the healthcare context in which this request is made. |
| Short | Encounter in which the request was created |
| Control | 0..0 |
| Type | Reference(Encounter) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | context |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 233. Bundle.entry:serviceRequest.resource.occurrence[x] | |
| Definition | The date/time at which the requested service should occur. |
| Short | When service should occur |
| Control | 0..0 |
| Type | Choice of: dateTime, Period, Timing |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Alternate Names | schedule |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 235. Bundle.entry:serviceRequest.resource.asNeeded[x] | |
| Definition | If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. |
| Short | Preconditions for service |
| Control | 0..0 |
| Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodes (example to http://hl7.org/fhir/ValueSet/medication-as-needed-reason|5.0.0)A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. |
| Type | Choice of: boolean, CodeableConcept |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 237. Bundle.entry:serviceRequest.resource.authoredOn | |
| Definition | When the request transitioned to being actionable. |
| Short | Date request signed |
| Control | 0..0 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Alternate Names | orderedOn |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 239. Bundle.entry:serviceRequest.resource.requester | |
| Definition | The individual who initiated the request and has responsibility for its activation. |
| Short | Who/what is requesting service |
| Comments | This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource. |
| Control | 0..1 |
| Type | Reference(Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | author, orderer |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 241. Bundle.entry:serviceRequest.resource.requester.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 243. Bundle.entry:serviceRequest.resource.requester.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.requester.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 245. Bundle.entry:serviceRequest.resource.requester.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Control | 1..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 247. Bundle.entry:serviceRequest.resource.requester.type | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)Aa resource (or, for logical models, the URI of the logical model). |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 249. Bundle.entry:serviceRequest.resource.requester.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..0 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 251. Bundle.entry:serviceRequest.resource.requester.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Short | Text alternative for the resource |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Control | 0..0 This element is affected by the following invariants: ref-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 253. Bundle.entry:serviceRequest.resource.performerType | |
| Definition | Desired type of performer for doing the requested service. |
| Short | Performer role |
| Comments | This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, “compounding pharmacy”, “psychiatrist” or “internal referral”. |
| Control | 0..0 |
| Binding | For example codes, see ParticipantRoles (example to http://hl7.org/fhir/ValueSet/participant-role|5.0.0)Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | specialty |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 255. Bundle.entry:serviceRequest.resource.performer | |
| Definition | The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. |
| Short | Requested performer |
| Comments | If multiple performers are present, it is interpreted as a list of alternative performers without any preference regardless of order. If order of preference is needed use the http://hl7.org/fhir/StructureDefinition/request-performerOrder. Use CareTeam to represent a group of performers (for example, Practitioner A and Practitioner B). |
| Control | 0..0 |
| Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Patient, Device, RelatedPerson) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | request recipient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 257. Bundle.entry:serviceRequest.resource.location | |
| Definition | The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center. |
| Short | Requested location |
| Control | 0..0 |
| Binding | For example codes, see ServiceDeliveryLocationRoleType (example to http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType)A location type where services are delivered. |
| Type | CodeableReference(Location) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 259. Bundle.entry:serviceRequest.resource.reason | |
| Definition | An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in |
| Short | Explanation/Justification for procedure or service |
| Comments | This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise, use |
| Control | 0..0 |
| Binding | For example codes, see ProcedureReasonCodes (example to http://hl7.org/fhir/ValueSet/procedure-reason|5.0.0)SNOMED CT Condition/Problem/Diagnosis Codes |
| Type | CodeableReference(Condition, Observation, DiagnosticReport, DocumentReference, DetectedIssue) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 261. Bundle.entry:serviceRequest.resource.insurance | |
| Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. |
| Short | Associated insurance coverage |
| Control | 0..0 |
| Type | Reference(Coverage, ClaimResponse) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 263. Bundle.entry:serviceRequest.resource.supportingInfo | |
| Definition | Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements. |
| Short | Additional clinical information |
| Comments | To represent information about how the services are to be delivered use the |
| Control | 0..0 |
| Type | CodeableReference(Resource) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | Ask at order entry question, AOE |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 265. Bundle.entry:serviceRequest.resource.specimen | |
| Definition | One or more specimens that the laboratory procedure will use. |
| Short | Procedure Samples |
| Comments | The purpose of the ServiceRequest.specimen is to reflect the actual specimen that the requested test/procedure is asked to be performed on, whether the lab already has it or not. References to specimens for purposes other than to perform a test/procedure on should be made using the ServiceRequest.supportingInfo or the Specimen.parent where the Specimen.parent would enable descendency and ServiceRequest.supportingInfo a general reference for context. |
| Control | 1..1 |
| Type | Reference(Specimen) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 267. Bundle.entry:serviceRequest.resource.specimen.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 269. Bundle.entry:serviceRequest.resource.specimen.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.specimen.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 271. Bundle.entry:serviceRequest.resource.specimen.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Control | 1..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 273. Bundle.entry:serviceRequest.resource.specimen.type | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)Aa resource (or, for logical models, the URI of the logical model). |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 275. Bundle.entry:serviceRequest.resource.specimen.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 277. Bundle.entry:serviceRequest.resource.specimen.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Short | Text alternative for the resource |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 279. Bundle.entry:serviceRequest.resource.bodySite | |
| Definition | Anatomic location where the procedure should be performed. This is the target site. |
| Short | Coded location on Body |
| Comments | Only used if not implicit in the code found in ServiceRequest.code. 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 http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure. |
| Control | 0..0 This element is affected by the following invariants: bdystr-1 |
| Binding | For example codes, see SNOMEDCTBodyStructures (example to http://hl7.org/fhir/ValueSet/body-site|5.0.0)SNOMED CT Body site concepts |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Knowing where the procedure is performed is important for tracking if multiple sites are possible. |
| Alternate Names | location |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 281. Bundle.entry:serviceRequest.resource.bodyStructure | |
| Definition | Anatomic location where the procedure should be performed. This is the target site. |
| Short | BodyStructure-based location on the body |
| Control | 0..1 This element is affected by the following invariants: bdystr-1 |
| Type | Reference(BodyStructure) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Knowing where the procedure is performed is important for tracking if multiple sites are possible. |
| Alternate Names | locationStructure |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 283. Bundle.entry:serviceRequest.resource.note | |
| Definition | Any other notes and comments made about the service request. For example, internal billing notes. |
| Short | Comments |
| Control | 0..* |
| Type | Annotation |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 285. Bundle.entry:serviceRequest.resource.note.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 287. Bundle.entry:serviceRequest.resource.note.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.note.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 289. Bundle.entry:serviceRequest.resource.note.author[x] | |
| Definition | The individual responsible for making the annotation. |
| Short | Individual responsible for the annotation |
| Comments | Organization is used when there's no need for specific attribution as to who made the comment. |
| Control | 0..0 |
| Type | Choice of: Reference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization), string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 291. Bundle.entry:serviceRequest.resource.note.time | |
| Definition | Indicates when this particular annotation was made. |
| Short | When the annotation was made |
| Control | 0..0 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 293. Bundle.entry:serviceRequest.resource.note.text | |
| Definition | The text of the annotation in markdown format. |
| Short | The annotation - text content (as markdown) |
| Control | 1..1 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 295. Bundle.entry:serviceRequest.resource.patientInstruction | |
| Definition | Instructions in terms that are understood by the patient or consumer. |
| Short | Patient or consumer-oriented instructions |
| Control | 0..0 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 301. Bundle.entry:serviceRequest.resource.relevantHistory | |
| Definition | Key events in the history of the request. |
| Short | Request provenance |
| Comments | This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject. |
| Control | 0..0 |
| Type | Reference(Provenance) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 303. Bundle.entry:serviceRequest.search | |
| Definition | Information about the search process that lead to the creation of this entry. |
| Short | Search related information |
| Control | 0..0 This element is affected by the following invariants: bdl-2 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 310. Bundle.entry:serviceRequest.request | |
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. |
| Short | Additional execution information (transaction/batch/history) |
| Control | 1..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 312. Bundle.entry:serviceRequest.request.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 314. Bundle.entry:serviceRequest.request.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 316. Bundle.entry:serviceRequest.request.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 318. Bundle.entry:serviceRequest.request.method | |
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. |
| Short | GET | HEAD | POST | PUT | DELETE | PATCH |
| Control | 1..1 This element is affected by the following invariants: bdl-3b, bdl-3c, bdl-14, bdl-15 |
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|5.0.0)HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 320. Bundle.entry:serviceRequest.request.url | |
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). |
| Short | URL for HTTP equivalent of this entry |
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 322. Bundle.entry:serviceRequest.request.ifNoneMatch | |
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". |
| Short | For managing cache validation |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 324. Bundle.entry:serviceRequest.request.ifModifiedSince | |
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". |
| Short | For managing cache currency |
| Control | 0..1 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 326. Bundle.entry:serviceRequest.request.ifMatch | |
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". |
| Short | For managing update contention |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 328. Bundle.entry:serviceRequest.request.ifNoneExist | |
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). |
| Short | For conditional creates |
| Control | 0..0 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 330. Bundle.entry:serviceRequest.response | |
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. |
| Short | Results of execution (transaction/batch/history) |
| Control | 0..0 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3d, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 340. Bundle.entry:patient | |
| Slice Name | patient |
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | Entry in the bundle - will have a resource or information |
| Control | 0..1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())bdl-8: fullUrl cannot be a version specific reference ( fullUrl.exists() implies fullUrl.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) |
| 342. Bundle.entry:patient.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 344. Bundle.entry:patient.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 346. Bundle.entry:patient.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 348. Bundle.entry:patient.link | |
| Definition | A series of links that provide context to this entry. |
| Short | Links related to this entry |
| Control | 0..* |
| Type | Seettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 350. Bundle.entry:patient.fullUrl | |
| Definition | The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
|
| Short | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). |
| Control | 1..1 This element is affected by the following invariants: bdl-7, bdl-15, bdl-8 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))urn-uuid: fullUrl must be a urn:uuid: reference for POST transaction entries ( matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')) |
| 352. Bundle.entry:patient.resource | |
| Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
| Short | Information about an individual or animal receiving health care services |
| Control | 1..1 |
| Type | Patient(SenaitePatient |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | SubjectOfCare Client Resident |
| Invariants | no-internal-id-on-create: The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create (identifier.where(use = 'usual').empty()) |
| 354. Bundle.entry:patient.resource.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| 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. |
| Control | 0..0 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 356. Bundle.entry:patient.resource.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 | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 358. Bundle.entry:patient.resource.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 | A set of rules under which this content was created |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 360. Bundle.entry:patient.resource.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| 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). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 362. Bundle.entry:patient.resource.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 | Text summary of the resource, for human interpretation |
| 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. |
| Control | 0..1 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | narrative, html, xhtml, display |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 364. Bundle.entry:patient.resource.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 | Contained, inline 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. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 366. Bundle.entry:patient.resource.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 368. Bundle.entry:patient.resource.extension:estimatedDateBirth | |
| Slice Name | estimatedDateBirth |
| Definition | true if the date of birth is unknown precisely |
| Short | If the date of birth was not known precisely |
| Control | 0..1 |
| Type | Extension(EstimatedDateBirth) (Extension Type: boolean) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | 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()) |
| 370. Bundle.entry:patient.resource.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 | Extensions that cannot be ignored |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 372. Bundle.entry:patient.resource.identifier | |
| Definition | An identifier for this patient. |
| Short | An identifier for this patient |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Patients are almost always assigned specific numerical identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 374. Bundle.entry:patient.resource.identifier:senaiteId | |
| Slice Name | senaiteId |
| Definition | The internal SENAITE Patient ID. Human readable and generated by SENAITE when the Patient is created. It must not be supplied by a client on an external create — a POST entry carrying it is rejected. Once assigned it may be used to identify the Patient on reads, on subsequent updates, and in Bundle.entry.request.ifNoneExist. |
| Short | Internal SENAITE Patient ID — server-assigned, do not include on create |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Patients are almost always assigned specific numerical identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 376. Bundle.entry:patient.resource.identifier:senaiteId.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 378. Bundle.entry:patient.resource.identifier:senaiteId.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 380. Bundle.entry:patient.resource.identifier:senaiteId.use | |
| Definition | The purpose of this identifier. |
| Short | usual |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 382. Bundle.entry:patient.resource.identifier:senaiteId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..0 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 384. Bundle.entry:patient.resource.identifier:senaiteId.system | |
| Definition | The namespace for the internal SENAITE Patient ID. Mandatory. Configurable per deployment; where a deployment has not defined its own URI, use the default https://fhir.senaite.org/NamingSystem/patient-id declared by SenaitePatientIdNamingSystem. |
| Short | Internal Patient ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/patient-id |
| Comments | Identifier.system is always case sensitive. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 386. Bundle.entry:patient.resource.identifier:senaiteId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | Internal SENAITE patient identifier — alphanumeric and hyphens only |
| 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. |
| Control | 1..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 388. Bundle.entry:patient.resource.identifier:senaiteId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..0 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 390. Bundle.entry:patient.resource.identifier:senaiteId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..0 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 392. Bundle.entry:patient.resource.identifier:mrn | |
| Slice Name | mrn |
| Definition | The consumer-owned business identifier for the patient — most often a Medical Record Number (MRN) — originating in the API consumer's system. Unlike the internal ID this may be supplied on create, and is preserved as-is by SENAITE. |
| Short | External Patient ID from the consumer's system — may be supplied on create |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Patients are almost always assigned specific numerical identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 394. Bundle.entry:patient.resource.identifier:mrn.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 396. Bundle.entry:patient.resource.identifier:mrn.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 398. Bundle.entry:patient.resource.identifier:mrn.use | |
| Definition | The purpose of this identifier. |
| Short | secondary |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 400. Bundle.entry:patient.resource.identifier:mrn.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 402. Bundle.entry:patient.resource.identifier:mrn.system | |
| Definition | The namespace for the consumer's own patient identifier. Mandatory. Normally the URI of the consumer's patient registry, agreed at integration time; where the consumer or deployment has none, use the default https://fhir.senaite.org/NamingSystem/patient-mrn declared by SenaitePatientMrnNamingSystem. A system is required because request.ifNoneExist and the identifier search parameter match on system and value and ignore Identifier.use. |
| Short | External Patient ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/patient-mrn |
| Comments | Identifier.system is always case sensitive. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 404. Bundle.entry:patient.resource.identifier:mrn.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | External patient identifier, typically an MRN — alphanumeric and hyphens only |
| 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. |
| Control | 1..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 406. Bundle.entry:patient.resource.identifier:mrn.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..0 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 408. Bundle.entry:patient.resource.identifier:mrn.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..0 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 410. Bundle.entry:patient.resource.active | |
| Definition | Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. |
| Short | Whether this patient's record is in active use |
| Comments | If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Need to be able to mark a patient record as not to be used because it was created in error. |
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 412. Bundle.entry:patient.resource.name | |
| Definition | A name associated with the individual. |
| Short | A name associated with the patient |
| Comments | A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Animal names may be communicated as given names, and optionally may include a family name. |
| Control | 1..* |
| Type | HumanName |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 414. Bundle.entry:patient.resource.name.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 416. Bundle.entry:patient.resource.name.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.name.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 418. Bundle.entry:patient.resource.name.use | |
| Definition | Identifies the purpose for this name. |
| Short | usual | official | temp | nickname | anonymous | old | maiden |
| Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NameUse (required to http://hl7.org/fhir/ValueSet/name-use|5.0.0)The use of a human name. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 420. Bundle.entry:patient.resource.name.text | |
| Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. |
| Short | Text representation of the full name |
| Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
| Control | 0..0 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | A renderable, unencoded form. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 422. Bundle.entry:patient.resource.name.family | |
| Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. |
| Short | Family name (often called 'Surname') |
| Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Alternate Names | surname |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 424. Bundle.entry:patient.resource.name.given | |
| Definition | Given name. |
| Short | Given names (not always 'first'). Includes middle names |
| Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Alternate Names | first name, middle name |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 426. Bundle.entry:patient.resource.name.prefix | |
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. |
| Short | Parts that come before the name |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 428. Bundle.entry:patient.resource.name.suffix | |
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. |
| Short | Parts that come after the name |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 430. Bundle.entry:patient.resource.name.period | |
| Definition | Indicates the period of time when this name was valid for the named person. |
| Short | Time period when name was/is in use |
| Control | 0..0 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows names to be placed in historical context. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 432. Bundle.entry:patient.resource.telecom | |
| Definition | A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. |
| Short | A contact detail for the individual |
| Comments | A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone). |
| Control | 0..* |
| Type | ContactPoint |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | People have (primary) ways to contact them in some way such as phone, email. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 434. Bundle.entry:patient.resource.telecom.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 436. Bundle.entry:patient.resource.telecom.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.telecom.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 438. Bundle.entry:patient.resource.telecom.system | |
| Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. |
| Short | phone | fax | email | pager | url | sms | other |
| Control | 0..1 This element is affected by the following invariants: cpt-2 |
| Binding | The codes SHALL be taken from ContactPointSystem (required to http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0)Telecommunications form for contact point. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 440. Bundle.entry:patient.resource.telecom.value | |
| Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
| Short | The actual contact point details |
| Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
| Control | 0..1 This element is affected by the following invariants: cpt-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need to support legacy numbers that are not in a tightly controlled format. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 442. Bundle.entry:patient.resource.telecom.use | |
| Definition | Identifies the purpose for the contact point. |
| Short | home | work | temp | old | mobile - purpose of this contact point |
| Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ContactPointUse (required to http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0)Use of contact point. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 444. Bundle.entry:patient.resource.telecom.rank | |
| Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. |
| Short | Specify preferred order of use (1 = highest) |
| Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions. Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts. |
| Control | 0..1 |
| Type | positiveInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 446. Bundle.entry:patient.resource.telecom.period | |
| Definition | Time period when the contact point was/is in use. |
| Short | Time period when the contact point was/is in use |
| Control | 0..0 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 448. Bundle.entry:patient.resource.gender | |
| Definition | Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. |
| Short | male | female | other | unknown |
| Comments | The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from AdministrativeGender (required to http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0)The gender of a person used for administrative purposes. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Needed for identification of the individual, in combination with (at least) name and birth date. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 450. Bundle.entry:patient.resource.birthDate | |
| Definition | The date of birth for the individual. |
| Short | The date of birth for the individual |
| Comments | Partial dates are allowed if the specific date of birth is unknown. There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). |
| Control | 1..1 |
| Type | date |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Age of the individual drives many clinical processes. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 452. Bundle.entry:patient.resource.deceased[x] | |
| Definition | Indicates if the individual is deceased or not. |
| Short | Indicates if the individual is deceased or not |
| Comments | If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. |
| Control | 0..1 |
| Type | dateTime |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 454. Bundle.entry:patient.resource.address | |
| Definition | An address for the individual. |
| Short | An address for the individual |
| Comments | Patient may have multiple addresses with different uses or applicable periods. |
| Control | 0..* |
| Type | Address |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 456. Bundle.entry:patient.resource.maritalStatus | |
| Definition | This field contains a patient's most recent marital (civil) status. |
| Short | Marital (civil) status of a patient |
| Control | 0..1 |
| Binding | The codes SHALL be taken from MaritalStatusCodes (required to http://hl7.org/fhir/ValueSet/marital-status)The domestic partnership status of a person. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Most, if not all systems capture it. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 458. Bundle.entry:patient.resource.multipleBirth[x] | |
| Definition | Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). |
| Short | Whether patient is part of a multiple birth |
| Comments | Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). |
| Control | 0..0 |
| Type | Choice of: boolean, integer |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 460. Bundle.entry:patient.resource.photo | |
| Definition | Image of the patient. |
| Short | Image of the patient |
| Comments | Guidelines:
|
| Control | 0..0 |
| Type | Attachment |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 462. Bundle.entry:patient.resource.contact | |
| Definition | A contact party (e.g. guardian, partner, friend) for the patient. |
| Short | A contact party (e.g. guardian, partner, friend) for the patient |
| Comments | Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact. |
| Control | 0..0 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Need to track people you can contact about the patient. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))pat-1: SHALL at least contain a contact's details or a reference to an organization ( name.exists() or telecom.exists() or address.exists() or organization.exists()) |
| 474. Bundle.entry:patient.resource.communication | |
| Definition | A language which may be used to communicate with the patient about his or her health. |
| Short | A language which may be used to communicate with the patient about his or her health |
| Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. |
| Control | 0..0 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 481. Bundle.entry:patient.resource.generalPractitioner | |
| Definition | Patient's nominated care provider. |
| Short | Patient's nominated primary care provider |
| Comments | This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type. |
| Control | 0..0 |
| Type | Reference(Organization, Practitioner, PractitionerRole) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | careProvider |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 483. Bundle.entry:patient.resource.managingOrganization | |
| Definition | Organization that is the custodian of the patient record. |
| Short | Organization that is the custodian of the patient record |
| Comments | There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). |
| Control | 0..0 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Need to know who recognizes this patient record, manages and updates it. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 485. Bundle.entry:patient.resource.link | |
| Definition | Link to a Patient or RelatedPerson resource that concerns the same actual individual. |
| Short | Link to a Patient or RelatedPerson resource that concerns the same actual individual |
| Comments | There is no assumption that linked patient records have mutual links. |
| Control | 0..0 |
| Type | BackboneElement |
| Is Modifier | true because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by' |
| Must Support | false |
| Summary | true |
| Requirements | There are multiple use cases:
|
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 492. Bundle.entry:patient.search | |
| Definition | Information about the search process that lead to the creation of this entry. |
| Short | Search related information |
| Control | 0..0 This element is affected by the following invariants: bdl-2 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 499. Bundle.entry:patient.request | |
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. |
| Short | Additional execution information (transaction/batch/history) |
| Control | 1..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 501. Bundle.entry:patient.request.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 503. Bundle.entry:patient.request.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 505. Bundle.entry:patient.request.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 507. Bundle.entry:patient.request.method | |
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. |
| Short | GET | HEAD | POST | PUT | DELETE | PATCH |
| Control | 1..1 This element is affected by the following invariants: bdl-3b, bdl-3c, bdl-14, bdl-15 |
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|5.0.0)HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 509. Bundle.entry:patient.request.url | |
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). |
| Short | URL for HTTP equivalent of this entry |
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 511. Bundle.entry:patient.request.ifNoneMatch | |
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". |
| Short | For managing cache validation |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 513. Bundle.entry:patient.request.ifModifiedSince | |
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". |
| Short | For managing cache currency |
| Control | 0..1 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 515. Bundle.entry:patient.request.ifMatch | |
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". |
| Short | For managing update contention |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 517. Bundle.entry:patient.request.ifNoneExist | |
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). |
| Short | For conditional creates |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ifnoneexist-on-identifier: ifNoneExist must key on the resource's external (secondary) or internal (usual) identifier, and must include a system: identifier=<system>|<value> ( $this.matches('^identifier=[^|]+\|[^|]+$')) |
| 519. Bundle.entry:patient.response | |
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. |
| Short | Results of execution (transaction/batch/history) |
| Control | 0..0 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3d, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 529. Bundle.entry:practitioner | |
| Slice Name | practitioner |
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | Entry in the bundle - will have a resource or information |
| Control | 0..1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())bdl-8: fullUrl cannot be a version specific reference ( fullUrl.exists() implies fullUrl.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) |
| 531. Bundle.entry:practitioner.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 533. Bundle.entry:practitioner.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 535. Bundle.entry:practitioner.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 537. Bundle.entry:practitioner.link | |
| Definition | A series of links that provide context to this entry. |
| Short | Links related to this entry |
| Control | 0..* |
| Type | Seettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 539. Bundle.entry:practitioner.fullUrl | |
| Definition | The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
|
| Short | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). |
| Control | 1..1 This element is affected by the following invariants: bdl-7, bdl-15, bdl-8 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))urn-uuid: fullUrl must be a urn:uuid: reference for POST transaction entries ( matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')) |
| 541. Bundle.entry:practitioner.resource | |
| Definition | A person who is directly or indirectly involved in the provisioning of healthcare or related services. |
| Short | A person with a formal responsibility in the provisioning of healthcare or related services |
| Control | 1..1 |
| Type | Practitioner(SenaitePractitioner |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | no-internal-id-on-create: The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create (identifier.where(use = 'usual').empty()) |
| 543. Bundle.entry:practitioner.resource.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| 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. |
| Control | 0..0 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 545. Bundle.entry:practitioner.resource.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 | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 547. Bundle.entry:practitioner.resource.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 | A set of rules under which this content was created |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 549. Bundle.entry:practitioner.resource.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| 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). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 551. Bundle.entry:practitioner.resource.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 | Text summary of the resource, for human interpretation |
| 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. |
| Control | 0..1 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | narrative, html, xhtml, display |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 553. Bundle.entry:practitioner.resource.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 | Contained, inline 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. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 555. Bundle.entry:practitioner.resource.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | 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()) |
| 557. Bundle.entry:practitioner.resource.modifierExtension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Invariants | 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()) |
| 559. Bundle.entry:practitioner.resource.identifier | |
| Definition | An identifier that applies to this person in this role. |
| Short | An identifier for the person as this agent |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Often, specific identities are assigned for the agent. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
|
| 561. Bundle.entry:practitioner.resource.identifier:senaiteId | |
| Slice Name | senaiteId |
| Definition | The internal SENAITE Practitioner ID. Human readable and generated by SENAITE when the Practitioner is created. It must not be supplied by a client on an external create — a POST entry carrying it is rejected. Once assigned it may be used to identify the Practitioner on reads, on subsequent updates, and in Bundle.entry.request.ifNoneExist. |
| Short | Internal SENAITE Practitioner ID — server-assigned, do not include on create |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Often, specific identities are assigned for the agent. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 563. Bundle.entry:practitioner.resource.identifier:senaiteId.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 565. Bundle.entry:practitioner.resource.identifier:senaiteId.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 567. Bundle.entry:practitioner.resource.identifier:senaiteId.use | |
| Definition | The purpose of this identifier. |
| Short | usual |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 569. Bundle.entry:practitioner.resource.identifier:senaiteId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..0 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 571. Bundle.entry:practitioner.resource.identifier:senaiteId.system | |
| Definition | The namespace for the internal SENAITE Practitioner ID. Mandatory. Configurable per deployment; where a deployment has not defined its own URI, use the default https://fhir.senaite.org/NamingSystem/practitioner-id declared by SenaitePractitionerIdNamingSystem. |
| Short | Internal Practitioner ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/practitioner-id |
| Comments | Identifier.system is always case sensitive. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 573. Bundle.entry:practitioner.resource.identifier:senaiteId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | Internal SENAITE practitioner identifier — alphanumeric and hyphens only |
| 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. |
| Control | 1..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 575. Bundle.entry:practitioner.resource.identifier:senaiteId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..0 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 577. Bundle.entry:practitioner.resource.identifier:senaiteId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..0 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 579. Bundle.entry:practitioner.resource.identifier:externalId | |
| Slice Name | externalId |
| Definition | The consumer-owned business identifier for the practitioner, for example a national provider number or hospital staff ID, originating in the API consumer's system. Unlike the internal ID this may be supplied on create, and is preserved as-is by SENAITE. |
| Short | External Practitioner ID from the consumer's system — may be supplied on create |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Often, specific identities are assigned for the agent. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 581. Bundle.entry:practitioner.resource.identifier:externalId.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 583. Bundle.entry:practitioner.resource.identifier:externalId.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 585. Bundle.entry:practitioner.resource.identifier:externalId.use | |
| Definition | The purpose of this identifier. |
| Short | secondary |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 587. Bundle.entry:practitioner.resource.identifier:externalId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 589. Bundle.entry:practitioner.resource.identifier:externalId.system | |
| Definition | The namespace for the consumer's own practitioner identifier. Mandatory. Normally the URI of the consumer's provider registry, agreed at integration time; where the consumer or deployment has none, use the default https://fhir.senaite.org/NamingSystem/practitioner-external-id declared by SenaitePractitionerExternalIdNamingSystem. A system is required because request.ifNoneExist and the identifier search parameter match on system and value and ignore Identifier.use. |
| Short | External Practitioner ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/practitioner-external-id |
| Comments | Identifier.system is always case sensitive. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 591. Bundle.entry:practitioner.resource.identifier:externalId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | External practitioner identifier — alphanumeric and hyphens only |
| 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. |
| Control | 1..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 593. Bundle.entry:practitioner.resource.identifier:externalId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..0 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 595. Bundle.entry:practitioner.resource.identifier:externalId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..0 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 597. Bundle.entry:practitioner.resource.active | |
| Definition | Whether this practitioner's record is in active use. |
| Short | Whether this practitioner's record is in active use |
| Comments | If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Need to be able to mark a practitioner record as not to be used because it was created in error. |
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 599. Bundle.entry:practitioner.resource.name | |
| Definition | The name(s) associated with the practitioner. |
| Short | The name(s) associated with the practitioner |
| Comments | The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this:
|
| Control | 1..1 |
| Type | HumanName |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 601. Bundle.entry:practitioner.resource.name.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 603. Bundle.entry:practitioner.resource.name.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.name.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 605. Bundle.entry:practitioner.resource.name.use | |
| Definition | Identifies the purpose for this name. |
| Short | usual | official | temp | nickname | anonymous | old | maiden |
| Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NameUse (required to http://hl7.org/fhir/ValueSet/name-use|5.0.0)The use of a human name. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 607. Bundle.entry:practitioner.resource.name.text | |
| Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. |
| Short | Text representation of the full name |
| Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
| Control | 0..0 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | A renderable, unencoded form. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 609. Bundle.entry:practitioner.resource.name.family | |
| Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. |
| Short | Family name (often called 'Surname') |
| Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Alternate Names | surname |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 611. Bundle.entry:practitioner.resource.name.given | |
| Definition | Given name. |
| Short | Given names (not always 'first'). Includes middle names |
| Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Alternate Names | first name, middle name |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 613. Bundle.entry:practitioner.resource.name.prefix | |
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. |
| Short | Parts that come before the name |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 615. Bundle.entry:practitioner.resource.name.suffix | |
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. |
| Short | Parts that come after the name |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 617. Bundle.entry:practitioner.resource.name.period | |
| Definition | Indicates the period of time when this name was valid for the named person. |
| Short | Time period when name was/is in use |
| Control | 0..0 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows names to be placed in historical context. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 619. Bundle.entry:practitioner.resource.telecom | |
| Definition | A contact detail for the practitioner, e.g. a telephone number or an email address. |
| Short | A contact detail for the practitioner (that apply to all roles) |
| Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific. |
| Control | 0..* |
| Type | ContactPoint |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Need to know how to reach a practitioner independent to any roles the practitioner may have. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 621. Bundle.entry:practitioner.resource.gender | |
| Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
| Short | male | female | other | unknown |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AdministrativeGender (required to http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0)The gender of a person used for administrative purposes. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Needed to address the person correctly. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 623. Bundle.entry:practitioner.resource.birthDate | |
| Definition | The date of birth for the practitioner. |
| Short | The date on which the practitioner was born |
| Control | 0..1 |
| Type | date |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Needed for identification. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 625. Bundle.entry:practitioner.resource.deceased[x] | |
| Definition | Indicates if the practitioner is deceased or not. |
| Short | Indicates if the practitioner is deceased or not |
| Comments | If there's no value in the instance, it means there is no statement on whether or not the practitioner is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. |
| Control | 0..0 |
| Type | Choice of: boolean, dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 627. Bundle.entry:practitioner.resource.address | |
| Definition | Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. |
| Short | Address(es) of the practitioner that are not role specific (typically home address) |
| Comments | The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). |
| Control | 0..* |
| Type | Address |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 629. Bundle.entry:practitioner.resource.photo | |
| Definition | Image of the person. |
| Short | Image of the person |
| Control | 0..0 |
| Type | Attachment |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 631. Bundle.entry:practitioner.resource.qualification | |
| Definition | The official qualifications, certifications, accreditations, training, licenses (and other types of educations/skills/capabilities) that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board of licensure authorizing the practitioner to practice medicine within a certain locality. |
| Short | Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care |
| Comments | The PractitionerRole.specialty defines the functional role that they are practicing at a given organization or location. Those specialties may or might not require a qualification, and are not defined on the practitioner. |
| Control | 0..0 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 640. Bundle.entry:practitioner.resource.communication | |
| Definition | A language which may be used to communicate with the practitioner, often for correspondence/administrative purposes. The |
| Short | A language which may be used to communicate with the practitioner |
| Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Practitioner.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. |
| Control | 0..0 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 647. Bundle.entry:practitioner.search | |
| Definition | Information about the search process that lead to the creation of this entry. |
| Short | Search related information |
| Control | 0..0 This element is affected by the following invariants: bdl-2 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 654. Bundle.entry:practitioner.request | |
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. |
| Short | Additional execution information (transaction/batch/history) |
| Control | 1..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 656. Bundle.entry:practitioner.request.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 658. Bundle.entry:practitioner.request.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 660. Bundle.entry:practitioner.request.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 662. Bundle.entry:practitioner.request.method | |
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. |
| Short | GET | HEAD | POST | PUT | DELETE | PATCH |
| Control | 1..1 This element is affected by the following invariants: bdl-3b, bdl-3c, bdl-14, bdl-15 |
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|5.0.0)HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 664. Bundle.entry:practitioner.request.url | |
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). |
| Short | URL for HTTP equivalent of this entry |
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 666. Bundle.entry:practitioner.request.ifNoneMatch | |
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". |
| Short | For managing cache validation |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 668. Bundle.entry:practitioner.request.ifModifiedSince | |
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". |
| Short | For managing cache currency |
| Control | 0..1 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 670. Bundle.entry:practitioner.request.ifMatch | |
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". |
| Short | For managing update contention |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 672. Bundle.entry:practitioner.request.ifNoneExist | |
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). |
| Short | For conditional creates |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ifnoneexist-on-identifier: ifNoneExist must key on the resource's external (secondary) or internal (usual) identifier, and must include a system: identifier=<system>|<value> ( $this.matches('^identifier=[^|]+\|[^|]+$')) |
| 674. Bundle.entry:practitioner.response | |
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. |
| Short | Results of execution (transaction/batch/history) |
| Control | 0..0 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3d, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 684. Bundle.entry:specimen | |
| Slice Name | specimen |
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | Entry in the bundle - will have a resource or information |
| Control | 1..1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())bdl-8: fullUrl cannot be a version specific reference ( fullUrl.exists() implies fullUrl.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) |
| 686. Bundle.entry:specimen.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 688. Bundle.entry:specimen.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 690. Bundle.entry:specimen.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 692. Bundle.entry:specimen.link | |
| Definition | A series of links that provide context to this entry. |
| Short | Links related to this entry |
| Control | 0..* |
| Type | Seettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 694. Bundle.entry:specimen.fullUrl | |
| Definition | The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
|
| Short | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). |
| Control | 1..1 This element is affected by the following invariants: bdl-7, bdl-15, bdl-8 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))urn-uuid: fullUrl must be a urn:uuid: reference for POST transaction entries ( matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')) |
| 696. Bundle.entry:specimen.resource | |
| Definition | A sample to be used for analysis. |
| Short | Sample for analysis |
| Control | 1..1 |
| Type | Specimen(SenaiteSpecimen |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | no-internal-id-on-create: The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create (identifier.where(use = 'usual').empty())no-barcode-on-create: The barcode label (SenaiteSpecimenBarcode) is generated by SENAITE and must not be supplied on an external create ( extension.where(url = 'https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode').empty()) |
| 698. Bundle.entry:specimen.resource.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| 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. |
| Control | 0..0 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 700. Bundle.entry:specimen.resource.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 | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 702. Bundle.entry:specimen.resource.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 | A set of rules under which this content was created |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 704. Bundle.entry:specimen.resource.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| 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). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 706. Bundle.entry:specimen.resource.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 | Text summary of the resource, for human interpretation |
| 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. |
| Control | 0..1 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | narrative, html, xhtml, display |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 708. Bundle.entry:specimen.resource.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 | Contained, inline 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. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 710. Bundle.entry:specimen.resource.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.extension. The slices are Unordered and Closed, and defines no disciminators to differentiate the slices |
| 712. Bundle.entry:specimen.resource.extension:barcode | |
| Slice Name | barcode |
| Definition | The barcode label for the specimen container, generated by SENAITE. It encodes the Sample ID by default, or the Client Sample ID where the deployment is configured to use it. SHALL be present on every Specimen returned by SENAITE. SHALL NOT be supplied by a consumer: a SenaiteRequestBundle whose Specimen entry carries it is rejected. |
| Short | Barcode label (base64 PDF or image) — SHALL be present when returned by SENAITE; SHALL NOT be supplied on create |
| Control | 0..1 |
| Type | Extension(SENAITE Specimen Barcode) (Extension Type: Attachment) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | 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()) |
| 714. Bundle.entry:specimen.resource.modifierExtension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Invariants | 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()) |
| 716. Bundle.entry:specimen.resource.identifier | |
| Definition | Id for specimen. |
| Short | External Identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
|
| 718. Bundle.entry:specimen.resource.identifier:senaiteId | |
| Slice Name | senaiteId |
| Definition | The SENAITE sample Object ID. Human readable and generated by SENAITE when the Sample is created, and shared between the Specimen and DiagnosticReport, which hold the same value. This identifier tracks the specimen throughout its processing lifecycle in the laboratory. It must not be supplied by a client on an external create — a POST entry carrying it is rejected. Once assigned it may be used to identify the Specimen on reads and subsequent updates. |
| Short | Internal SENAITE Sample ID — matches the DiagnosticReport usual identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 720. Bundle.entry:specimen.resource.identifier:senaiteId.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 722. Bundle.entry:specimen.resource.identifier:senaiteId.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 724. Bundle.entry:specimen.resource.identifier:senaiteId.use | |
| Definition | The purpose of this identifier. |
| Short | usual |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 726. Bundle.entry:specimen.resource.identifier:senaiteId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..0 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 728. Bundle.entry:specimen.resource.identifier:senaiteId.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | Sample ID namespace — mandatory and fixed by this IG |
| Comments | Identifier.system is always case sensitive. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Fixed Value | |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 730. Bundle.entry:specimen.resource.identifier:senaiteId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | Internal SENAITE sample identifier — alphanumeric and hyphens only |
| 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. |
| Control | 1..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 732. Bundle.entry:specimen.resource.identifier:senaiteId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..0 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 734. Bundle.entry:specimen.resource.identifier:senaiteId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..0 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 736. Bundle.entry:specimen.resource.identifier:clientSampleId | |
| Slice Name | clientSampleId |
| Definition | The Client Sample ID: a consumer-owned business identifier for the Sample, assigned outside SENAITE (e.g. by a laboratory information system or an EHR order number). Unlike the internal ID this may be supplied on create, on the Specimen entry of a SenaiteRequestBundle, or entered against the Sample by laboratory staff in the web application. SENAITE preserves the value as-is. Where the deployment is configured to do so, it is the value encoded in the specimen container barcode in place of the Sample ID. The same value appears on the corresponding DiagnosticReport. |
| Short | External Client Sample ID assigned by the consumer's system — may be supplied on create |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 738. Bundle.entry:specimen.resource.identifier:clientSampleId.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 740. Bundle.entry:specimen.resource.identifier:clientSampleId.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 742. Bundle.entry:specimen.resource.identifier:clientSampleId.use | |
| Definition | The purpose of this identifier. |
| Short | secondary |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 744. Bundle.entry:specimen.resource.identifier:clientSampleId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 746. Bundle.entry:specimen.resource.identifier:clientSampleId.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | Client Sample ID namespace — mandatory and fixed by this IG |
| Comments | Identifier.system is always case sensitive. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Fixed Value | |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 748. Bundle.entry:specimen.resource.identifier:clientSampleId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | Client Sample ID — alphanumeric and hyphens only |
| 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. |
| Control | 1..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 750. Bundle.entry:specimen.resource.identifier:clientSampleId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..0 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 752. Bundle.entry:specimen.resource.identifier:clientSampleId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..0 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 754. Bundle.entry:specimen.resource.accessionIdentifier | |
| 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. |
| Short | Identifier assigned by the lab |
| Control | 0..0 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 756. Bundle.entry:specimen.resource.status | |
| Definition | The availability of the specimen. |
| Short | available | unavailable | unsatisfactory | entered-in-error |
| Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from SpecimenStatus (required to http://hl7.org/fhir/ValueSet/specimen-status|5.0.0)Codes providing the status/availability of a specimen. |
| Type | code |
| Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 758. Bundle.entry:specimen.resource.type | |
| Definition | The kind of material that forms the specimen. |
| Short | Kind of material that forms the specimen |
| 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. |
| Control | 1..1 |
| Binding | For example codes, see hl7VS-specimenType (example to http://terminology.hl7.org/ValueSet/v2-0487)The type of the specimen. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 760. Bundle.entry:specimen.resource.type.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 762. Bundle.entry:specimen.resource.type.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.type.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 764. Bundle.entry:specimen.resource.type.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Short | Code defined by a terminology system |
| 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. |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from http://snomed.info/sct (preferred to http://snomed.info/sct) |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 766. Bundle.entry:specimen.resource.type.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 768. Bundle.entry:specimen.resource.type.coding.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.type.coding.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 770. Bundle.entry:specimen.resource.type.coding.system | |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Short | Identity of the terminology system |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 772. Bundle.entry:specimen.resource.type.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 | Version of the system - if relevant |
| 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. |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..0 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 774. Bundle.entry:specimen.resource.type.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 | Symbol in syntax defined by the system |
| Control | 0..1 This element is affected by the following invariants: cod-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need to refer to a particular code in the system. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 776. Bundle.entry:specimen.resource.type.coding.display | |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Short | Representation defined by the system |
| Control | 0..1 This element is affected by the following invariants: cod-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 778. Bundle.entry:specimen.resource.type.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 | If this coding was chosen directly by the user |
| 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. |
| Control | 0..0 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 780. Bundle.entry:specimen.resource.type.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 | Plain text representation of the concept |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 782. Bundle.entry:specimen.resource.subject | |
| 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, a biologically-derived product, or a device. |
| Short | 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, a biologically-derived product, or a device |
| Control | 0..0 |
| Type | Reference(Patient, Group, Device, BiologicallyDerivedProduct, Substance, Location) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Must know the subject context. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 784. Bundle.entry:specimen.resource.receivedTime | |
| Definition | Time when specimen is received by the testing laboratory for processing or testing. |
| Short | The time when specimen is received by the testing laboratory |
| Control | 0..0 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 786. Bundle.entry:specimen.resource.parent | |
| Definition | Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. |
| Short | Specimen from which this specimen originated |
| 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. |
| Control | 0..0 |
| Type | Reference(Specimen) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 788. Bundle.entry:specimen.resource.request | |
| Definition | Details concerning a service request that required a specimen to be collected. |
| Short | Why the specimen was collected |
| Comments | The request may be explicit or implied such with a ServiceRequest that requires a blood draw. |
| Control | 0..0 |
| Type | Reference(ServiceRequest) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 790. Bundle.entry:specimen.resource.combined | |
| Definition | This element signifies if the specimen is part of a group or pooled. |
| Short | grouped | pooled |
| Control | 0..0 |
| Binding | The codes SHALL be taken from SpecimenCombined (required to http://hl7.org/fhir/ValueSet/specimen-combined|5.0.0)Codes for the combined status of a specimen. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 792. Bundle.entry:specimen.resource.role | |
| Definition | The role or reason for the specimen in the testing workflow. |
| Short | The role the specimen serves |
| Control | 0..0 |
| Binding | The codes SHOULD be taken from SpecimenRole (preferred to http://hl7.org/fhir/ValueSet/specimen-role|5.0.0)Codes describing specimen role. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 794. Bundle.entry:specimen.resource.feature | |
| Definition | A physical feature or landmark on a specimen, highlighted for context by the collector of the specimen (e.g. surgeon), that identifies the type of feature as well as its meaning (e.g. the red ink indicating the resection margin of the right lobe of the excised prostate tissue or wire loop at radiologically suspected tumor location). |
| Short | The physical feature of a specimen |
| Control | 0..0 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 801. Bundle.entry:specimen.resource.collection | |
| Definition | Details concerning the specimen collection. |
| Short | Collection details |
| Control | 1..1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 803. Bundle.entry:specimen.resource.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 805. Bundle.entry:specimen.resource.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 807. Bundle.entry:specimen.resource.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 809. Bundle.entry:specimen.resource.collection.collector | |
| Definition | Person who collected the specimen. |
| Short | Who collected the specimen |
| Control | 0..1 |
| Type | Reference(Practitioner, PractitionerRole, Patient, RelatedPerson) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 811. Bundle.entry:specimen.resource.collection.collected[x] | |
| Definition | Time when specimen was collected from subject - the physiologically relevant time. |
| Short | Collection time |
| Control | 0..1 |
| Type | dateTime |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 813. Bundle.entry:specimen.resource.collection.duration | |
| Definition | The span of time over which the collection of a specimen occurred. |
| Short | How long it took to collect specimen |
| Control | 0..0 |
| Type | Duration |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 815. Bundle.entry:specimen.resource.collection.quantity | |
| Definition | The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. |
| Short | The quantity of specimen collected |
| Control | 0..0 |
| Type | Quantity(SimpleQuantity) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) |
| 817. Bundle.entry:specimen.resource.collection.method | |
| Definition | A coded value specifying the technique that is used to perform the procedure. |
| Short | Technique used to perform collection |
| Control | 0..0 |
| Binding | For example codes, see FHIRSpecimenCollectionMethod (example to http://hl7.org/fhir/ValueSet/specimen-collection-method|5.0.0)The technique that is used to perform the procedure. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 819. Bundle.entry:specimen.resource.collection.device | |
| Definition | A coded value specifying the technique that is used to perform the procedure. |
| Short | Device used to perform collection |
| Control | 0..1 |
| Binding | The device that was used to obtain the specimen (e.g. a catheter or catheter part used to draw the blood via a central line). |
| Type | CodeableReference(Device) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 821. Bundle.entry:specimen.resource.collection.procedure | |
| Definition | The procedure event during which the specimen was collected (e.g. the surgery leading to the collection of a pathology sample). |
| Short | The procedure that collects the specimen |
| Control | 0..1 |
| Type | Reference(Procedure) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 823. Bundle.entry:specimen.resource.collection.bodySite | |
| 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. |
| Short | Anatomical collection site |
| Comments | Reasons for using BodyStructure reference include: 1.) Need to identify a specific site instance (e.g. a specific mole), 2.) a single pre-coordinated coded concept for the body site does not exist, 3.) a desire to represent bodySite using multiple attributes (e.g. modifiers). |
| Control | 0..1 |
| Binding | For example codes, see SNOMEDCTBodyStructures (example to http://hl7.org/fhir/ValueSet/body-site|5.0.0)SNOMED CT Body site concepts |
| Type | CodeableReference(BodyStructure) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 825. Bundle.entry:specimen.resource.collection.fastingStatus[x] | |
| Definition | Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection. |
| Short | Whether or how long patient abstained from food and/or drink |
| 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 |
| Control | 0..0 |
| Binding | Unless not suitable, these codes SHALL be taken from hl7VS-relevantClincialInformation (extensible to http://terminology.hl7.org/ValueSet/v2-0916)Codes describing the fasting status of the patient. |
| Type | Choice of: CodeableConcept, Duration |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Many diagnostic tests require fasting to facilitate accurate interpretation. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 827. Bundle.entry:specimen.resource.processing | |
| Definition | Details concerning processing and processing steps for the specimen. |
| Short | Processing and processing step details |
| Control | 0..0 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 836. Bundle.entry:specimen.resource.container | |
| Definition | The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here. |
| Short | Direct container of specimen (tube/slide, etc.) |
| Control | 0..0 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 844. Bundle.entry:specimen.resource.condition | |
| Definition | A mode or state of being that describes the nature of the specimen. |
| Short | State of the specimen |
| 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. |
| Control | 0..0 |
| Binding | Unless not suitable, these codes SHALL be taken from hl7VS-specimenCondition (extensible to http://terminology.hl7.org/ValueSet/v2-0493)Codes describing the state of the specimen. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | The specimen condition can be used to assess its quality or appropriateness for a specific test. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 846. Bundle.entry:specimen.resource.note | |
| Definition | To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen). |
| Short | Comments |
| Control | 0..* |
| Type | Annotation |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 848. Bundle.entry:specimen.search | |
| Definition | Information about the search process that lead to the creation of this entry. |
| Short | Search related information |
| Control | 0..0 This element is affected by the following invariants: bdl-2 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 855. Bundle.entry:specimen.request | |
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. |
| Short | Additional execution information (transaction/batch/history) |
| Control | 1..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 857. Bundle.entry:specimen.request.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 859. Bundle.entry:specimen.request.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 861. Bundle.entry:specimen.request.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 863. Bundle.entry:specimen.request.method | |
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. |
| Short | GET | HEAD | POST | PUT | DELETE | PATCH |
| Control | 1..1 This element is affected by the following invariants: bdl-3b, bdl-3c, bdl-14, bdl-15 |
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|5.0.0)HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 865. Bundle.entry:specimen.request.url | |
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). |
| Short | URL for HTTP equivalent of this entry |
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 867. Bundle.entry:specimen.request.ifNoneMatch | |
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". |
| Short | For managing cache validation |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 869. Bundle.entry:specimen.request.ifModifiedSince | |
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". |
| Short | For managing cache currency |
| Control | 0..1 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 871. Bundle.entry:specimen.request.ifMatch | |
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". |
| Short | For managing update contention |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 873. Bundle.entry:specimen.request.ifNoneExist | |
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). |
| Short | For conditional creates |
| Control | 0..0 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 875. Bundle.entry:specimen.response | |
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. |
| Short | Results of execution (transaction/batch/history) |
| Control | 0..0 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3d, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 885. Bundle.entry:organization | |
| Slice Name | organization |
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | Entry in the bundle - will have a resource or information |
| Control | 0..1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())bdl-8: fullUrl cannot be a version specific reference ( fullUrl.exists() implies fullUrl.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) |
| 887. Bundle.entry:organization.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 889. Bundle.entry:organization.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 891. Bundle.entry:organization.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 893. Bundle.entry:organization.link | |
| Definition | A series of links that provide context to this entry. |
| Short | Links related to this entry |
| Control | 0..* |
| Type | Seettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 895. Bundle.entry:organization.fullUrl | |
| Definition | The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
|
| Short | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). |
| Control | 1..1 This element is affected by the following invariants: bdl-7, bdl-15, bdl-8 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))urn-uuid: fullUrl must be a urn:uuid: reference for POST transaction entries ( matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')) |
| 897. Bundle.entry:organization.resource | |
| Definition | A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. |
| Short | A grouping of people or organizations with a common purpose |
| Control | 1..1 |
| Type | Organization(SenaiteOrganization |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | no-internal-id-on-create: The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create (identifier.where(use = 'usual').empty()) |
| 899. Bundle.entry:organization.resource.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| 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. |
| Control | 0..0 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 901. Bundle.entry:organization.resource.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 | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 903. Bundle.entry:organization.resource.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 | A set of rules under which this content was created |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 905. Bundle.entry:organization.resource.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| 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). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 907. Bundle.entry:organization.resource.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 | Text summary of the resource, for human interpretation |
| 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. |
| Control | 0..1 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | narrative, html, xhtml, display |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 909. Bundle.entry:organization.resource.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 | Contained, inline 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. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 911. Bundle.entry:organization.resource.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 913. Bundle.entry:organization.resource.modifierExtension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Invariants | 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()) |
| 915. Bundle.entry:organization.resource.identifier | |
| Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. |
| Short | Identifies this organization across multiple systems |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* This element is affected by the following invariants: org-1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
|
| 917. Bundle.entry:organization.resource.identifier:senaiteId | |
| Slice Name | senaiteId |
| Definition | The internal SENAITE Client ID. Human readable and generated by SENAITE when the Client Organisation is created. It must not be supplied by a client on an external create — a POST entry carrying it is rejected. Once assigned it may be used to identify the Organization on reads, on subsequent updates, and in Bundle.entry.request.ifNoneExist. |
| Short | Internal SENAITE Client ID — server-assigned, do not include on create |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 This element is affected by the following invariants: org-1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 919. Bundle.entry:organization.resource.identifier:senaiteId.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 921. Bundle.entry:organization.resource.identifier:senaiteId.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 923. Bundle.entry:organization.resource.identifier:senaiteId.use | |
| Definition | The purpose of this identifier. |
| Short | usual |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 925. Bundle.entry:organization.resource.identifier:senaiteId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..0 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 927. Bundle.entry:organization.resource.identifier:senaiteId.system | |
| Definition | The namespace for the internal SENAITE Client ID. Mandatory. Configurable per deployment; where a deployment has not defined its own URI, use the default https://fhir.senaite.org/NamingSystem/organization-id declared by SenaiteOrganizationIdNamingSystem. |
| Short | Internal Organization ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/organization-id |
| Comments | Identifier.system is always case sensitive. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 929. Bundle.entry:organization.resource.identifier:senaiteId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | Internal SENAITE client identifier — alphanumeric and hyphens only |
| 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. |
| Control | 1..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 931. Bundle.entry:organization.resource.identifier:senaiteId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..0 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 933. Bundle.entry:organization.resource.identifier:senaiteId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..0 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 935. Bundle.entry:organization.resource.identifier:externalId | |
| Slice Name | externalId |
| Definition | The consumer-owned business identifier for the organisation, for example a national organisation ID or an internal client code, originating in the API consumer's system. Unlike the internal ID this may be supplied on create, and is preserved as-is by SENAITE. |
| Short | External Organization ID from the consumer's system — may be supplied on create |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 This element is affected by the following invariants: org-1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 937. Bundle.entry:organization.resource.identifier:externalId.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 939. Bundle.entry:organization.resource.identifier:externalId.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Bundle.entry.resource.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 941. Bundle.entry:organization.resource.identifier:externalId.use | |
| Definition | The purpose of this identifier. |
| Short | secondary |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 943. Bundle.entry:organization.resource.identifier:externalId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 945. Bundle.entry:organization.resource.identifier:externalId.system | |
| Definition | The namespace for the consumer's own organisation identifier. Mandatory. Normally the URI of the consumer's organisation registry, agreed at integration time; where the consumer or deployment has none, use the default https://fhir.senaite.org/NamingSystem/organization-external-id declared by SenaiteOrganizationExternalIdNamingSystem. A system is required because request.ifNoneExist and the identifier search parameter match on system and value and ignore Identifier.use. |
| Short | External Organization ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/organization-external-id |
| Comments | Identifier.system is always case sensitive. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 947. Bundle.entry:organization.resource.identifier:externalId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | External organisation identifier — alphanumeric and hyphens only |
| 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. |
| Control | 1..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 949. Bundle.entry:organization.resource.identifier:externalId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..0 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 951. Bundle.entry:organization.resource.identifier:externalId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..0 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 953. Bundle.entry:organization.resource.active | |
| Definition | Whether the organization's record is still in active use. |
| Short | Whether the organization's record is still in active use |
| Comments | This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. |
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 955. Bundle.entry:organization.resource.type | |
| Definition | The kind(s) of organization that this is. |
| Short | Kind of organization |
| Comments | Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. |
| Control | 0..0 |
| Binding | For example codes, see OrganizationType (example to http://hl7.org/fhir/ValueSet/organization-type|5.0.0)Used to categorize the organization. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 957. Bundle.entry:organization.resource.name | |
| Definition | A name associated with the organization. |
| Short | Name used for the organization |
| Comments | If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. |
| Control | 1..1 This element is affected by the following invariants: org-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Need to use the name as the label of the organization. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 959. Bundle.entry:organization.resource.alias | |
| Definition | A list of alternate names that the organization is known as, or was known as in the past. |
| Short | A list of alternate names that the organization is known as, or was known as in the past |
| Comments | There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization. |
| Control | 0..0 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 961. Bundle.entry:organization.resource.description | |
| Definition | Description of the organization, which helps provide additional general context on the organization to ensure that the correct organization is selected. |
| Short | Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name |
| Control | 0..0 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Humans need additional information to verify a correct Organization has been selected. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 963. Bundle.entry:organization.resource.contact | |
| Definition | The contact details of communication devices available relevant to the specific Organization. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites. |
| Short | Official contact details for the Organization |
| Comments | The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the Organization itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc. |
| Control | 0..* |
| Type | ExtendedContactDetail |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Need to keep track of assigned contact points within bigger organization. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))org-3: The telecom of an organization can never be of use 'home' ( telecom.where(use = 'home').empty())org-4: The address of an organization can never be of use 'home' ( address.where(use = 'home').empty()) |
| 965. Bundle.entry:organization.resource.partOf | |
| Definition | The organization of which this organization forms a part. |
| Short | The organization of which this organization forms a part |
| Control | 0..1 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Need to be able to track the hierarchy of organizations within an organization. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 967. Bundle.entry:organization.resource.endpoint | |
| Definition | Technical endpoints providing access to services operated for the organization. |
| Short | Technical endpoints providing access to services operated for the organization |
| Control | 0..0 |
| Type | Reference(Endpoint) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 969. Bundle.entry:organization.resource.qualification | |
| Definition | The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization. For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization. |
| Short | Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care |
| Control | 0..0 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 978. Bundle.entry:organization.search | |
| Definition | Information about the search process that lead to the creation of this entry. |
| Short | Search related information |
| Control | 0..0 This element is affected by the following invariants: bdl-2 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 985. Bundle.entry:organization.request | |
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. |
| Short | Additional execution information (transaction/batch/history) |
| Control | 1..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 987. Bundle.entry:organization.request.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 | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 989. Bundle.entry:organization.request.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 | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 991. Bundle.entry:organization.request.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 | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 |
| Invariants | 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()) |
| 993. Bundle.entry:organization.request.method | |
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. |
| Short | GET | HEAD | POST | PUT | DELETE | PATCH |
| Control | 1..1 This element is affected by the following invariants: bdl-3b, bdl-3c, bdl-14, bdl-15 |
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|5.0.0)HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 995. Bundle.entry:organization.request.url | |
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). |
| Short | URL for HTTP equivalent of this entry |
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 997. Bundle.entry:organization.request.ifNoneMatch | |
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". |
| Short | For managing cache validation |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 999. Bundle.entry:organization.request.ifModifiedSince | |
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". |
| Short | For managing cache currency |
| Control | 0..1 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 1001. Bundle.entry:organization.request.ifMatch | |
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". |
| Short | For managing update contention |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 1003. Bundle.entry:organization.request.ifNoneExist | |
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). |
| Short | For conditional creates |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ifnoneexist-on-identifier: ifNoneExist must key on the resource's external (secondary) or internal (usual) identifier, and must include a system: identifier=<system>|<value> ( $this.matches('^identifier=[^|]+\|[^|]+$')) |
| 1005. Bundle.entry:organization.response | |
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. |
| Short | Results of execution (transaction/batch/history) |
| Control | 0..0 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3d, bdl-5 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 1015. Bundle.signature | |
| Definition | Digital Signature - base64 encoded. XML-DSig or a JWS. |
| Short | Digital Signature |
| Comments | The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific. |
| Control | 0..0 |
| Type | Signature |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 1017. Bundle.issues | |
| Definition | Captures issues and warnings that relate to the construction of the Bundle and the content within it. |
| Short | Issues with the Bundle |
| Comments | Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle. |
| Control | 0..1 This element is affected by the following invariants: bdl-16, bdl-17 |
| Type | Resource(OperationOutcome |
| Is Modifier | false |
| Must Support | false |
| Summary | true |