CH EMR (R4)
0.1.0 - ci-build
CH EMR (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ehealthsuisse/ch-emr/ and changes regularly. See the Directory of published versions
| Draft as of 2026-06-04 |
Definitions for the ch-emr-bundle resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Bundle | |||||||||
| Definition | A container for a collection of resources. | ||||||||
| Short | CH IPS DocumentContains a collection of resources | ||||||||
| Control | 0..* | ||||||||
| Is Modifier | false | ||||||||
| Impose Profile | This profile also requires that the instance also conform this additional profile: | ||||||||
| 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 ( entry.search.empty() or (type = 'searchset'))bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited ( entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')))bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited ( entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')))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&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-1: total only when a search or history (total.empty() or (type = 'searchset') or (type = 'history')) bdl-2: entry.search only when a search (entry.search.empty() or (type = 'searchset')) bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited (entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))) bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited (entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))) 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&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)) | ||||||||
| 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 it's 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 it's meaning or interpretation | ||||||||
| 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())) | ||||||||
| 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 | 10..1 | ||||||||
| 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())) | ||||||||
| 6. Bundle.identifier.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..1 | ||||||||
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)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())) | ||||||||
| 8. Bundle.identifier.system | |||||||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||||||
| Short | The 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())) | ||||||||
| 10. Bundle.identifier.value | |||||||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||||||
| Short | The 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 Rendered Value extension. 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 | ||||||||
| 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())) | ||||||||
| 12. Bundle.type | |||||||||
| Definition | Indicates the purpose of this bundle - how it is intended to be used. | ||||||||
| Short | documentdocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | ||||||||
| 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 | ||||||||
| Binding | The codes SHALL be taken from BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 (required to http://hl7.org/fhir/ValueSet/bundle-type|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Fixed Value | document | ||||||||
| 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 | 10..1 | ||||||||
| Type | instant | ||||||||
| 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())) | ||||||||
| 16. 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 | ||||||||
| 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| Slicing | This element introduces a set of slices on Bundle.entry. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 18. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 20. Bundle.entry.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 22. Bundle.entry:Composition | |||||||||
| Slice Name | Composition | ||||||||
| 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 | ||||||||
| 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 24. Bundle.entry:Composition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 26. Bundle.entry:Composition.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 28. Bundle.entry:Composition.resource | |||||||||
| Definition | A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.). The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | CH IPS CompositionA resource in the bundle | ||||||||
| Comments | While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical. | ||||||||
| Control | 10..1 | ||||||||
| Type | CompositionResource(CH Emergency Record Composition) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 30. 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 | 10..1* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 32. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 34. Bundle.entry:Patient.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 36. Bundle.entry:Patient.resource | |||||||||
| Definition | The CH Core Patient is based upon the core FHIR Patient Resource and designed to meet the applicable patient demographic data elements in Switzerland. See also https://www.bfs.admin.ch/bfs/de/home/register/personenregister/registerharmonisierung/nomenklaturen.html for further information The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | CH IPS PatientA resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | PatientResource(CH IPS Patient) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | SubjectOfCare Client Resident | ||||||||
| 38. 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 it's 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 it's meaning or interpretation | ||||||||
| 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())) | ||||||||
| 40. Bundle.entry:Patient.resource.extension:placeOfBirth | |||||||||
| Slice Name | placeOfBirth | ||||||||
| Definition | The registered place of birth of the patient. | ||||||||
| Short | Place of birth of the patient | ||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
| Type | Extension(Place of Birth according to eCH-0011) (Extension Type: Address(Address for Place of Birth)) | ||||||||
| 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())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||
| 42. Bundle.entry:Patient.resource.extension:placeOfOrigin | |||||||||
| Slice Name | placeOfOrigin | ||||||||
| Definition | The registered place of origin of the patient. | ||||||||
| Short | Place of origin(s) of the patient | ||||||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||||||
| Type | Extension(Place of Origin according to eCH-0011) (Extension Type: Address) | ||||||||
| 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())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||
| 44. Bundle.entry:Patient.resource.extension:citizenship | |||||||||
| Slice Name | citizenship | ||||||||
| Definition | The content of the country code element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, if the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. | ||||||||
| Short | Information on nationality data (eCH: Staatsangehörigkeit/Nationalité) of the patient | ||||||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||||||
| Type | Extension(Patient Citizenship) (Complex Extension) | ||||||||
| Is Modifier | 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())ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code ( ((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))) | ||||||||
| 46. Bundle.entry:Patient.resource.extension:religion | |||||||||
| Slice Name | religion | ||||||||
| Definition | The patient's professed religious affiliations. | ||||||||
| Short | Religion of the patient | ||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
| Type | Extension(Patient Religion) (Extension Type: CodeableConcept) | ||||||||
| 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())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||
| 48. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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 | ||||||||
| Summary | false | ||||||||
| 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()) | ||||||||
| 50. 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 | ||||||||
| 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 areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 52. Bundle.entry:Patient.resource.identifier:EPR-SPID | |||||||||
| Slice Name | EPR-SPID | ||||||||
| Definition | EPR-SPID: The Central Compensation Office (ZAS; CCO) assigns and manages the new patient identification number according to the EPRA (EPR-SPID), which is only linked internally in the CCO with the AHV number. It maintains the UPI identification database (Unique Personal Identifier Database), which the EPR communities may access. The law regulates how the the EPR-SPID can be used. SR 816.111 states (Art. 10 para. 3 EPDV) that communities must ensure that the EPR-SPID number cannot be not stored in document repositories or document registries. An identifier for this patient. | ||||||||
| Short | EPR-SPIDAn identifier for this patient | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..* | ||||||||
| Type | Identifier(EPR-SPID Identifier) | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||||||
| Pattern Value | { | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 54. Bundle.entry:Patient.resource.identifier:AHVN13 | |||||||||
| Slice Name | AHVN13 | ||||||||
| Definition | The AHVN13 / NAVS13 - (abbreviation for new thirteen-digit Social Security number) - is an administrative identifier for natural persons in Switzerland. It is issued, announced and administered by the Central Compensation Office. It is available to all organisations and communities for which there is a legal basis. An identifier for this patient. | ||||||||
| Short | AHVN13 / NAVS13 of the patient (13 digits starting with 756, no separation points)An identifier for this patient | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..* | ||||||||
| Type | Identifier(AHVN13 / NAVS13 Identifier) | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||||||
| Pattern Value | { | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 56. Bundle.entry:Patient.resource.identifier:LocalPid | |||||||||
| Slice Name | LocalPid | ||||||||
| Definition | An identifier for this patient. | ||||||||
| Short | Local patient identifier(s)An identifier for this patient | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..* | ||||||||
| Type | Identifier | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||||||
| Pattern Value | { | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 58. Bundle.entry:Patient.resource.identifier:LocalPid.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..1 | ||||||||
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)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())) | ||||||||
| 60. Bundle.entry:Patient.resource.identifier:LocalPid.system | |||||||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||||||
| Short | The 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())) | ||||||||
| 62. Bundle.entry:Patient.resource.identifier:LocalPid.value | |||||||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||||||
| Short | The 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 Rendered Value extension. 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 | ||||||||
| 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())) | ||||||||
| 64. Bundle.entry:Patient.resource.identifier:insuranceCardNumber | |||||||||
| Slice Name | insuranceCardNumber | ||||||||
| Definition | Cardnumber Swiss insurance card v1 An identifier for this patient. | ||||||||
| Short | Insurance card number of the patient (20 digits)An identifier for this patient | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..* | ||||||||
| Type | Identifier(Insurance Card Number (Identifier)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||||||
| Pattern Value | { | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 66. 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 | ||||||||
| 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())) | ||||||||
| 68. 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 | ||||||||
| 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())) | ||||||||
| Slicing | This element introduces a set of slices on Bundle.entry.resource.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 70. 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 | 10..1 This element is affected by the following invariants: cpt-2 | ||||||||
| Binding | The codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)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())) | ||||||||
| 72. 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 | 10..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 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())) | ||||||||
| 74. 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 ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)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())) | ||||||||
| 76. Bundle.entry:Patient.resource.telecom:email | |||||||||
| Slice Name | |||||||||
| 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(CH Core ContactPoint eCH-0046 Email) | ||||||||
| Is Modifier | 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())) | ||||||||
| 78. Bundle.entry:Patient.resource.telecom:email.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 | 10..1 This element is affected by the following invariants: cpt-2 | ||||||||
| Binding | The codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)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 | ||||||||
| Fixed Value | email | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 80. Bundle.entry:Patient.resource.telecom:email.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 | 10..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 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())) | ||||||||
| 82. Bundle.entry:Patient.resource.telecom:email.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 ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)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())) | ||||||||
| 84. Bundle.entry:Patient.resource.telecom:email.use.extension:emailCategory | |||||||||
| Slice Name | emailCategory | ||||||||
| Definition | Optional Extension Element - found in all resources. | ||||||||
| Short | Optional Extensions Element | ||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
| Type | Extension(eCH-0046 Email Category) (Extension Type: CodeableConcept) | ||||||||
| 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())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||
| 86. Bundle.entry:Patient.resource.telecom:phone | |||||||||
| Slice Name | phone | ||||||||
| 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(CH Core ContactPoint eCH-0046 Phone) | ||||||||
| Is Modifier | 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())) | ||||||||
| 88. Bundle.entry:Patient.resource.telecom:phone.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 | 10..1 This element is affected by the following invariants: cpt-2 | ||||||||
| Binding | The codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)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 | ||||||||
| Fixed Value | phone | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 90. Bundle.entry:Patient.resource.telecom:phone.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 | 10..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 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())) | ||||||||
| 92. Bundle.entry:Patient.resource.telecom:phone.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 ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)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())) | ||||||||
| 94. Bundle.entry:Patient.resource.telecom:phone.use.extension:phoneCategory | |||||||||
| Slice Name | phoneCategory | ||||||||
| Definition | Optional Extension Element - found in all resources. | ||||||||
| Short | Optional Extensions Element | ||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
| Type | Extension(eCH-0046 Phone Category) (Extension Type: CodeableConcept) | ||||||||
| 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())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||
| 96. Bundle.entry:Patient.resource.telecom:internet | |||||||||
| Slice Name | internet | ||||||||
| 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(CH Core ContactPoint eCH-0046 Internet) | ||||||||
| Is Modifier | 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())) | ||||||||
| 98. Bundle.entry:Patient.resource.telecom:internet.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 | 10..1 This element is affected by the following invariants: cpt-2 | ||||||||
| Binding | The codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)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 | ||||||||
| Fixed Value | url | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 100. Bundle.entry:Patient.resource.telecom:internet.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 | 10..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 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())) | ||||||||
| 102. Bundle.entry:Patient.resource.telecom:internet.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 ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)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())) | ||||||||
| 104. Bundle.entry:Patient.resource.telecom:internet.use.extension:internetCategory | |||||||||
| Slice Name | internetCategory | ||||||||
| Definition | Optional Extension Element - found in all resources. | ||||||||
| Short | Optional Extensions Element | ||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
| Type | Extension(eCH-0046 Internet Category) (Extension Type: CodeableConcept) | ||||||||
| 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())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||
| 106. 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 | Choice of: boolean, 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 | ||||||||
| 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())) | ||||||||
| 108. 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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())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()) | ||||||||
| Slicing | This element introduces a set of slices on Bundle.entry.resource.contact. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 110. Bundle.entry:Patient.resource.contact.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 112. Bundle.entry:Patient.resource.contact:contact | |||||||||
| Slice Name | contact | ||||||||
| Definition | A contact party (e.g. guardian, partner, friend) for the patient. | ||||||||
| Short | Contact data if it is not the address of the patientA 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..1* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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())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()) | ||||||||
| 114. Bundle.entry:Patient.resource.contact:contact.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 116. Bundle.entry:Patient.resource.contact:contact.relationship | |||||||||
| Definition | The nature of the relationship between the patient and the contact person. | ||||||||
| Short | The kind of relationship | ||||||||
| Control | 10..1* | ||||||||
| Binding | Unless not suitable, these codes SHALL be taken from PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1 (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1)The nature of the relationship between a patient and a contact person for that patient. | ||||||||
| Type | CodeableConcept | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||||||
| Pattern Value | { | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 118. Bundle.entry:Patient.resource.contact:contact.telecom | |||||||||
| Definition | A contact detail for the person, e.g. a telephone number or an email address. | ||||||||
| Short | A contact detail for the person | ||||||||
| Comments | Contact 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. | ||||||||
| Control | 0..0* | ||||||||
| Type | ContactPoint | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 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())) | ||||||||
| 120. Bundle.entry:Patient.resource.contact:contact.address | |||||||||
| Definition | Address for the contact person. | ||||||||
| Short | Address for the contact person | ||||||||
| Control | 10..1 | ||||||||
| Type | Address(CH Core Postal Address) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 122. Bundle.entry:Patient.resource.contact:nameOfParent | |||||||||
| Slice Name | nameOfParent | ||||||||
| Definition | A contact party (e.g. guardian, partner, friend) for the patient. | ||||||||
| Short | Name of parentA 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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())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()) | ||||||||
| 124. Bundle.entry:Patient.resource.contact:nameOfParent.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 126. Bundle.entry:Patient.resource.contact:nameOfParent.relationship | |||||||||
| Definition | The nature of the relationship between the patient and the contact person. | ||||||||
| Short | The kind of relationship | ||||||||
| Control | 10..1* | ||||||||
| Binding | Unless not suitable, these codes SHALL be taken from PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1 (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1)The nature of the relationship between a patient and a contact person for that patient. | ||||||||
| Type | CodeableConcept | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||||||
| Pattern Value | { | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 128. Bundle.entry:Patient.resource.contact:nameOfParent.name | |||||||||
| Definition | A name associated with the contact person. | ||||||||
| Short | A name associated with the contact person | ||||||||
| Control | 10..1 | ||||||||
| Type | HumanName | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 130. 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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())) | ||||||||
| 132. Bundle.entry:Patient.resource.communication.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 134. Bundle.entry:Patient.resource.communication.language | |||||||||
| Definition | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. | ||||||||
| Short | The language which can be used to communicate with the patient about his or her health | ||||||||
| Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. | ||||||||
| Control | 1..1 | ||||||||
| Binding | The codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1 (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||||||
| Type | CodeableConcept | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | false | ||||||||
| Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 136. Bundle.entry:Patient.resource.link | |||||||||
| Definition | Link to another patient resource that concerns the same actual patient. | ||||||||
| Short | Link to another patient resource that concerns the same actual person | ||||||||
| Comments | There is no assumption that linked patient records have mutual links. | ||||||||
| Control | 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' | ||||||||
| 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())) | ||||||||
| 138. Bundle.entry:Patient.resource.link.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 140. Bundle.entry:Patient.resource.link.other | |||||||||
| Definition | The other patient resource that the link refers to. | ||||||||
| Short | The other patient or related person resource that the link refers to | ||||||||
| Comments | Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. | ||||||||
| Control | 1..1 | ||||||||
| Type | Reference(Patient, RelatedPerson) | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 142. Bundle.entry:Patient.resource.link.type | |||||||||
| Definition | The type of link between this patient resource and another patient resource. | ||||||||
| Short | replaced-by | replaces | refer | seealso | ||||||||
| Control | 1..1 | ||||||||
| Binding | The codes SHALL be taken from LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)The type of link between this patient resource and another patient resource. | ||||||||
| 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())) | ||||||||
| 144. 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 146. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 148. Bundle.entry:Practitioner.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 150. Bundle.entry:Practitioner.resource | |||||||||
| Definition | The CH Core Practitioner is based upon the core FHIR Practitioner Resource and designed to meet the applicable practitioner demographic data elements in Switzerland. See also https://www.bfs.admin.ch/bfs/de/home/register/personenregister/registerharmonisierung/nomenklaturen.html for further information The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | CH IPS PractitionerA resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | PractitionerResource(CH IPS Practitioner) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 152. Bundle.entry:PractitionerRole | |||||||||
| Slice Name | PractitionerRole | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 154. Bundle.entry:PractitionerRole.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 156. Bundle.entry:PractitionerRole.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 158. Bundle.entry:PractitionerRole.resource | |||||||||
| Definition | A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | CH IPS PractitionerRoleA resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | PractitionerRoleResource(CH IPS PractitionerRole) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 160. 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 162. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 164. Bundle.entry:Organization.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 166. 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. | ||||||||
| Short | CH IPS OrganizationA resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | OrganizationResource(CH IPS Organization) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 168. Bundle.entry:RelatedPerson | |||||||||
| Slice Name | RelatedPerson | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 170. Bundle.entry:RelatedPerson.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 172. Bundle.entry:RelatedPerson.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 174. Bundle.entry:RelatedPerson.resource | |||||||||
| Definition | Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | CH Core RelatedPersonA resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | RelatedPersonResource(CH Emergency Record RelatedPerson) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 176. Bundle.entry:Device | |||||||||
| Slice Name | Device | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 178. Bundle.entry:Device.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 180. Bundle.entry:Device.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 182. Bundle.entry:Device.resource | |||||||||
| Definition | A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | Item used in healthcareA resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | DeviceResource(Device) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 184. Bundle.entry:Encounter | |||||||||
| Slice Name | Encounter | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 186. Bundle.entry:Encounter.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 188. Bundle.entry:Encounter.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 190. Bundle.entry:Encounter.resource | |||||||||
| Definition | This is basic constraint on Encounter for use in CH Core resources. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | CH Core EncounterA resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | Resource(CH Core Encounter) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Visit | ||||||||
| 192. Bundle.entry:Location | |||||||||
| Slice Name | Location | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 194. Bundle.entry:Location.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 196. Bundle.entry:Location.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 198. Bundle.entry:Location.resource | |||||||||
| Definition | Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | CH Core LocationA resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | Resource(CH Core Location) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 200. Bundle.entry:AllergyIntolerance | |||||||||
| Slice Name | AllergyIntolerance | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 202. Bundle.entry:AllergyIntolerance.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 204. Bundle.entry:AllergyIntolerance.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 206. Bundle.entry:AllergyIntolerance.resource | |||||||||
| Definition | Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | CH IPS AllergyIntoleranceA resource in the bundle | ||||||||
| Comments | Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings. | ||||||||
| Control | 10..1 | ||||||||
| Type | AllergyIntoleranceResource(CH IPS AllergyIntolerance) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Allergy, Intolerance, Adverse Reaction | ||||||||
| 208. Bundle.entry:Condition | |||||||||
| Slice Name | Condition | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 210. Bundle.entry:Condition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 212. Bundle.entry:Condition.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 214. Bundle.entry:Condition.resource | |||||||||
| Definition | A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | CH IPS ConditionA resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | ConditionResource(CH IPS Condition) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 216. Bundle.entry:DeviceUseStatement | |||||||||
| Slice Name | DeviceUseStatement | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 218. Bundle.entry:DeviceUseStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 220. Bundle.entry:DeviceUseStatement.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 222. Bundle.entry:DeviceUseStatement.resource | |||||||||
| Definition | A record of a device being used by a patient where the record is the result of a report from the patient or another clinician. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | Record of use of a deviceA resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | DeviceUseStatementResource(DeviceUseStatement (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 224. Bundle.entry:DiagnosticReport | |||||||||
| Slice Name | DiagnosticReport | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 226. Bundle.entry:DiagnosticReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 228. Bundle.entry:DiagnosticReport.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 230. Bundle.entry:DiagnosticReport.resource | |||||||||
| Definition | The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reportsA resource in the bundle | ||||||||
| Comments | This is intended to capture a single report and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing. | ||||||||
| Control | 10..1 | ||||||||
| Type | DiagnosticReportResource(DiagnosticReport (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Report, Test, Result, Results, Labs, Laboratory | ||||||||
| 232. Bundle.entry:ImagingStudy | |||||||||
| Slice Name | ImagingStudy | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 234. Bundle.entry:ImagingStudy.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 236. Bundle.entry:ImagingStudy.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 238. Bundle.entry:ImagingStudy.resource | |||||||||
| Definition | Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | A set of images produced in single study (one or more series of references images)A resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | ImagingStudyResource(ImagingStudy (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 240. Bundle.entry:Immunization | |||||||||
| Slice Name | Immunization | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 242. Bundle.entry:Immunization.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 244. Bundle.entry:Immunization.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 246. Bundle.entry:Immunization.resource | |||||||||
| Definition | Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | CH IPS ImmunizationA resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | ImmunizationResource(CH IPS Immunization) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 248. Bundle.entry:Medication | |||||||||
| Slice Name | Medication | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 250. Bundle.entry:Medication.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 252. Bundle.entry:Medication.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 254. Bundle.entry:Medication.resource | |||||||||
| Definition | This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | CH IPS MedicationA resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | MedicationResource(CH IPS Medication) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 256. Bundle.entry:MedicationRequest | |||||||||
| Slice Name | MedicationRequest | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 258. Bundle.entry:MedicationRequest.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 260. Bundle.entry:MedicationRequest.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 262. Bundle.entry:MedicationRequest.resource | |||||||||
| Definition | An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | CH IPS MedicationRequestA resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | MedicationRequestResource(CH IPS MedicationRequest) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Prescription, Order | ||||||||
| 264. Bundle.entry:MedicationStatement | |||||||||
| Slice Name | MedicationStatement | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 266. Bundle.entry:MedicationStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 268. Bundle.entry:MedicationStatement.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 270. Bundle.entry:MedicationStatement.resource | |||||||||
| Definition | A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | CH IPS MedicationStatementA resource in the bundle | ||||||||
| Comments | When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered: MedicationStatement.status + MedicationStatement.wasNotTaken Status=Active + NotTaken=T = Not currently taking Status=Completed + NotTaken=T = Not taken in the past Status=Intended + NotTaken=T = No intention of taking Status=Active + NotTaken=F = Taking, but not as prescribed Status=Active + NotTaken=F = Taking Status=Intended +NotTaken= F = Will be taking (not started) Status=Completed + NotTaken=F = Taken in past Status=In Error + NotTaken=N/A = In Error. | ||||||||
| Control | 10..1 | ||||||||
| Type | MedicationStatementResource(CH IPS MedicationStatement) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 272. Bundle.entry:Procedure | |||||||||
| Slice Name | Procedure | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 274. Bundle.entry:Procedure.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 276. Bundle.entry:Procedure.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 278. Bundle.entry:Procedure.resource | |||||||||
| Definition | An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | An action that is being or was performed on a patientA resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | ProcedureResource(Procedure (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 280. Bundle.entry:ObservationPregnancyEdd | |||||||||
| Slice Name | ObservationPregnancyEdd | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 282. Bundle.entry:ObservationPregnancyEdd.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 284. Bundle.entry:ObservationPregnancyEdd.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 286. Bundle.entry:ObservationPregnancyEdd.resource | |||||||||
| Definition | Measurements and simple assertions made about a patient, device or other subject. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | Measurements and simple assertionsA resource in the bundle | ||||||||
| Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. | ||||||||
| Control | 10..1 | ||||||||
| Type | ObservationResource(Observation Pregnancy - Expected Delivery Date (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||||||
| 288. Bundle.entry:ObservationPregnancyOutcome | |||||||||
| Slice Name | ObservationPregnancyOutcome | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 290. Bundle.entry:ObservationPregnancyOutcome.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 292. Bundle.entry:ObservationPregnancyOutcome.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 294. Bundle.entry:ObservationPregnancyOutcome.resource | |||||||||
| Definition | Measurements and simple assertions made about a patient, device or other subject. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | Measurements and simple assertionsA resource in the bundle | ||||||||
| Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. | ||||||||
| Control | 10..1 | ||||||||
| Type | ObservationResource(Observation Pregnancy - Outcome (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||||||
| 296. Bundle.entry:ObservationPregnancyStatus | |||||||||
| Slice Name | ObservationPregnancyStatus | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 298. Bundle.entry:ObservationPregnancyStatus.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 300. Bundle.entry:ObservationPregnancyStatus.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 302. Bundle.entry:ObservationPregnancyStatus.resource | |||||||||
| Definition | Measurements and simple assertions made about a patient, device or other subject. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | Measurements and simple assertionsA resource in the bundle | ||||||||
| Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. | ||||||||
| Control | 10..1 | ||||||||
| Type | ObservationResource(Observation Pregnancy - Status (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||||||
| 304. Bundle.entry:ObservationAlcoholUse | |||||||||
| Slice Name | ObservationAlcoholUse | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 306. Bundle.entry:ObservationAlcoholUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 308. Bundle.entry:ObservationAlcoholUse.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 310. Bundle.entry:ObservationAlcoholUse.resource | |||||||||
| Definition | Measurements and simple assertions made about a patient, device or other subject. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | Measurements and simple assertionsA resource in the bundle | ||||||||
| Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. | ||||||||
| Control | 10..1 | ||||||||
| Type | ObservationResource(Observation Social History - Alcohol Use (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||||||
| 312. Bundle.entry:ObservationTobaccoUse | |||||||||
| Slice Name | ObservationTobaccoUse | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 314. Bundle.entry:ObservationTobaccoUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 316. Bundle.entry:ObservationTobaccoUse.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 318. Bundle.entry:ObservationTobaccoUse.resource | |||||||||
| Definition | Measurements and simple assertions made about a patient, device or other subject. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | Measurements and simple assertionsA resource in the bundle | ||||||||
| Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. | ||||||||
| Control | 10..1 | ||||||||
| Type | ObservationResource(Observation Social History - Tobacco Use (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||||||
| 320. Bundle.entry:ObservationResultsLaboratoryPathology | |||||||||
| Slice Name | ObservationResultsLaboratoryPathology | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 322. Bundle.entry:ObservationResultsLaboratoryPathology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 324. Bundle.entry:ObservationResultsLaboratoryPathology.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 326. Bundle.entry:ObservationResultsLaboratoryPathology.resource | |||||||||
| Definition | This observation may represent the result of a simple laboratory or pathology test such as hematocrit, or it may group the set of results produced by a multi-test study or panel such as a complete blood count, a dynamic function test, or a urine specimen study. In the latter case, the observation carries the overall conclusion of the study and references the atomic results of the study as "has-member" child observations The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | Laboratory (including Pathology) result for a simple test or for a panel/studyA resource in the bundle | ||||||||
| Comments | Represents either a lab simple observation or the group of observations produced by a laboratory study. | ||||||||
| Control | 10..1 | ||||||||
| Type | ObservationResource(Observation Results - Laboratory/Pathology (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||||||
| 328. Bundle.entry:observationResultsRadiology | |||||||||
| Slice Name | observationResultsRadiology | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 330. Bundle.entry:observationResultsRadiology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 332. Bundle.entry:observationResultsRadiology.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 334. Bundle.entry:observationResultsRadiology.resource | |||||||||
| Definition | Measurements and simple assertions made about a patient, device or other subject. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | Measurements and simple assertionsA resource in the bundle | ||||||||
| Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. | ||||||||
| Control | 10..1 | ||||||||
| Type | ObservationResource(Observation Results - Radiology (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||||||
| 336. Bundle.entry:ObservationVitalSigns | |||||||||
| Slice Name | ObservationVitalSigns | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 338. Bundle.entry:ObservationVitalSigns.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 340. Bundle.entry:ObservationVitalSigns.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 342. Bundle.entry:ObservationVitalSigns.resource | |||||||||
| Definition | The FHIR Vitals Signs profile sets minimum expectations for the Observation Resource to record, search and fetch the vital signs associated with a patient. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | FHIR Vital Signs ProfileA resource in the bundle | ||||||||
| Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. | ||||||||
| Control | 10..1 | ||||||||
| Type | ObservationResource(Vital Signs Profile) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||||||
| 344. 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 | 0..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 346. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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:Specimen.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 350. 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. | ||||||||
| Short | Sample for analysisA resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | SpecimenResource(Specimen (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 352. Bundle.entry:Flag | |||||||||
| Slice Name | Flag | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 354. Bundle.entry:Flag.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 356. Bundle.entry:Flag.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 358. Bundle.entry:Flag.resource | |||||||||
| Definition | Prospective warnings of potential issues when providing care to the patient. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | Key information to flag to healthcare providersA resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | FlagResource(Flag - Alert (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Barriers to Care, Alert, Warning | ||||||||
| 360. Bundle.entry:ClinicalImpression | |||||||||
| Slice Name | ClinicalImpression | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 362. Bundle.entry:ClinicalImpression.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 364. Bundle.entry:ClinicalImpression.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 366. Bundle.entry:ClinicalImpression.resource | |||||||||
| Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | A resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | ClinicalImpressionResource | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| 368. Bundle.entry:CarePlan | |||||||||
| Slice Name | CarePlan | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 370. Bundle.entry:CarePlan.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 372. Bundle.entry:CarePlan.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 374. Bundle.entry:CarePlan.resource | |||||||||
| Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | A resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | CarePlanResource | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| 376. Bundle.entry:Consent | |||||||||
| Slice Name | Consent | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 378. Bundle.entry:Consent.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 380. Bundle.entry:Consent.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 382. Bundle.entry:Consent.resource | |||||||||
| Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | A resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | ConsentResource | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| 384. Bundle.entry:DocumentReference | |||||||||
| Slice Name | DocumentReference | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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.contains('/_history/').not()) | ||||||||
| 386. Bundle.entry:DocumentReference.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 388. Bundle.entry:DocumentReference.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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())) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 390. Bundle.entry:DocumentReference.resource | |||||||||
| Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | A resource in the bundle | ||||||||
| Control | 10..1 | ||||||||
| Type | DocumentReferenceResource | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
Guidance on how to interpret the contents of this table can be foundhere
| 0. Bundle | |||||||||
| Impose Profile | This profile also requires that the instance also conform this additional profile: | ||||||||
| 2. Bundle.entry:Composition | |||||||||
| Slice Name | Composition | ||||||||
| 4. Bundle.entry:Composition.resource | |||||||||
| Type | Composition(CH Emergency Record Composition) | ||||||||
| 6. Bundle.entry:Patient | |||||||||
| Slice Name | Patient | ||||||||
| 8. Bundle.entry:Patient.resource | |||||||||
| 10. Bundle.entry:Patient.resource.communication | |||||||||
| 12. Bundle.entry:Patient.resource.communication.language | |||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 14. Bundle.entry:RelatedPerson | |||||||||
| Slice Name | RelatedPerson | ||||||||
| 16. Bundle.entry:RelatedPerson.resource | |||||||||
| Type | RelatedPerson(CH Emergency Record RelatedPerson) | ||||||||
Guidance on how to interpret the contents of this table can be foundhere
| 0. Bundle | |||||||||
| Definition | A container for a collection of resources. | ||||||||
| Short | CH IPS Document | ||||||||
| Control | 0..* | ||||||||
| Is Modifier | false | ||||||||
| Impose Profile | This profile also requires that the instance also conform this additional profile: | ||||||||
| 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 ( entry.search.empty() or (type = 'searchset'))bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited ( entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')))bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited ( entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')))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&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)) | ||||||||
| 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 | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||||||
| Control | 0..1 | ||||||||
| Type | id | ||||||||
| Is Modifier | 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 | ||||||||
| 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 it's 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 it's meaning or interpretation | ||||||||
| 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())) | ||||||||
| 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 SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||||||
| Type | code | ||||||||
| Is Modifier | false | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| 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 | 1..1 | ||||||||
| 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())) | ||||||||
| 12. Bundle.identifier.id | |||||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||
| Short | Unique id for inter-element referencing | ||||||||
| Control | 0..1 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 14. Bundle.identifier.extension | |||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 16. Bundle.identifier.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..1 | ||||||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)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())) | ||||||||
| 18. Bundle.identifier.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 Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)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())) | ||||||||
| 20. Bundle.identifier.system | |||||||||
| Definition | Establishes the namespace for the value - that is, a 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. | ||||||||
| 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())) | ||||||||
| 22. Bundle.identifier.value | |||||||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||||||
| Short | The 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 Rendered Value extension. 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 | ||||||||
| 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())) | ||||||||
| 24. Bundle.identifier.period | |||||||||
| Definition | Time period during which identifier is/was valid for use. | ||||||||
| Short | Time period when id is/was valid for use | ||||||||
| Control | 0..1 | ||||||||
| 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())) | ||||||||
| 26. Bundle.identifier.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..1 | ||||||||
| 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())) | ||||||||
| 28. Bundle.type | |||||||||
| Definition | Indicates the purpose of this bundle - how it is intended to be used. | ||||||||
| Short | document | ||||||||
| 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 | ||||||||
| Binding | The codes SHALL be taken from BundleType (required to http://hl7.org/fhir/ValueSet/bundle-type|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Fixed Value | document | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 30. 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 | 1..1 | ||||||||
| Type | instant | ||||||||
| 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())) | ||||||||
| 32. Bundle.total | |||||||||
| Definition | If a set of search matches, this is the 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..1 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 34. 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. | ||||||||
| Control | 0..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 36. Bundle.link.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 38. Bundle.link.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 40. Bundle.link.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 42. Bundle.link.relation | |||||||||
| Definition | A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1. | ||||||||
| Short | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||||||
| Control | 1..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())) | ||||||||
| 44. Bundle.link.url | |||||||||
| Definition | The reference details for the link. | ||||||||
| Short | Reference details for the link | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 46. 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 | ||||||||
| 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.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 areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 48. 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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 50. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 52. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 54. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 56. Bundle.entry.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 58. Bundle.entry.resource | |||||||||
| Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | A resource in the bundle | ||||||||
| Control | 0..1 | ||||||||
| Type | Resource | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| 60. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 62. 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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 64. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 66. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 68. 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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 70. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 72. 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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 74. 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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 76. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 78. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 80. 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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 82. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 84. 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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 86. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 88. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 90. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 92. 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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 94. 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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 96. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 98. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 100. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 102. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 104. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 106. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 108. 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 | ||||||||
| Summary | true | ||||||||
| 110. Bundle.entry:Composition | |||||||||
| Slice Name | Composition | ||||||||
| 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 | ||||||||
| 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 112. Bundle.entry:Composition.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 114. Bundle.entry:Composition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 116. Bundle.entry:Composition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 118. Bundle.entry:Composition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 120. Bundle.entry:Composition.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 122. Bundle.entry:Composition.resource | |||||||||
| Definition | A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.). | ||||||||
| Short | CH IPS Composition | ||||||||
| Comments | While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical. | ||||||||
| Control | 1..1 | ||||||||
| Type | Composition(CH Emergency Record Composition) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 124. Bundle.entry:Composition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 126. Bundle.entry:Composition.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 128. Bundle.entry:Composition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 130. Bundle.entry:Composition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 132. Bundle.entry:Composition.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 134. Bundle.entry:Composition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 136. Bundle.entry:Composition.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 138. Bundle.entry:Composition.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 140. Bundle.entry:Composition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 142. Bundle.entry:Composition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 144. Bundle.entry:Composition.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 146. Bundle.entry:Composition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 148. Bundle.entry:Composition.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 150. Bundle.entry:Composition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 152. Bundle.entry:Composition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 154. Bundle.entry:Composition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 156. Bundle.entry:Composition.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 158. Bundle.entry:Composition.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 160. Bundle.entry:Composition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 162. Bundle.entry:Composition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 164. Bundle.entry:Composition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 166. Bundle.entry:Composition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 168. Bundle.entry:Composition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 170. Bundle.entry:Composition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 172. Bundle.entry:Composition.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 | ||||||||
| Summary | true | ||||||||
| 174. 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 | 1..1 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 176. 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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 178. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 180. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 182. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 184. Bundle.entry:Patient.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 186. Bundle.entry:Patient.resource | |||||||||
| Definition | The CH Core Patient is based upon the core FHIR Patient Resource and designed to meet the applicable patient demographic data elements in Switzerland. See also https://www.bfs.admin.ch/bfs/de/home/register/personenregister/registerharmonisierung/nomenklaturen.html for further information | ||||||||
| Short | CH IPS Patient | ||||||||
| Control | 1..1 | ||||||||
| Type | Patient(CH IPS Patient) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | SubjectOfCare Client Resident | ||||||||
| 188. 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 | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||||||
| Control | 0..1 | ||||||||
| Type | id | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| 190. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 192. 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 it's 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 it's meaning or interpretation | ||||||||
| 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())) | ||||||||
| 194. 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 SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||||||
| Type | code | ||||||||
| Is Modifier | false | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Summary | false | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 196. 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 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 | ||||||||
| Type | Narrative | ||||||||
| Is Modifier | 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())) | ||||||||
| 198. 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, and nor can they have their own independent transaction scope. | ||||||||
| 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..* | ||||||||
| Type | Resource | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||||||
| 200. Bundle.entry:Patient.resource.extension | |||||||||
| Definition | An Extension | ||||||||
| Short | Extension | ||||||||
| Control | 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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 202. Bundle.entry:Patient.resource.extension:placeOfBirth | |||||||||
| Slice Name | placeOfBirth | ||||||||
| Definition | The registered place of birth of the patient. | ||||||||
| Short | Place of birth of the patient | ||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
| Type | Extension(Place of Birth according to eCH-0011) (Extension Type: Address(Address for Place of Birth)) | ||||||||
| 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()) | ||||||||
| 204. Bundle.entry:Patient.resource.extension:placeOfOrigin | |||||||||
| Slice Name | placeOfOrigin | ||||||||
| Definition | The registered place of origin of the patient. | ||||||||
| Short | Place of origin(s) of the patient | ||||||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||||||
| Type | Extension(Place of Origin according to eCH-0011) (Extension Type: Address) | ||||||||
| 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()) | ||||||||
| 206. Bundle.entry:Patient.resource.extension:citizenship | |||||||||
| Slice Name | citizenship | ||||||||
| Definition | The content of the country code element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, if the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. | ||||||||
| Short | Information on nationality data (eCH: Staatsangehörigkeit/Nationalité) of the patient | ||||||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||||||
| Type | Extension(Patient Citizenship) (Complex Extension) | ||||||||
| Is Modifier | 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())ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code ( ((extension.where(url='code').value.coding.code.length()=2) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((extension.where(url='code').value.coding.code.length() = 3) and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))) | ||||||||
| 208. Bundle.entry:Patient.resource.extension:religion | |||||||||
| Slice Name | religion | ||||||||
| Definition | The patient's professed religious affiliations. | ||||||||
| Short | Religion of the patient | ||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
| Type | Extension(Patient Religion) (Extension Type: CodeableConcept) | ||||||||
| 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()) | ||||||||
| 210. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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 | ||||||||
| Summary | false | ||||||||
| 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()) | ||||||||
| 212. 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 | ||||||||
| 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 areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 214. Bundle.entry:Patient.resource.identifier:EPR-SPID | |||||||||
| Slice Name | EPR-SPID | ||||||||
| Definition | EPR-SPID: The Central Compensation Office (ZAS; CCO) assigns and manages the new patient identification number according to the EPRA (EPR-SPID), which is only linked internally in the CCO with the AHV number. It maintains the UPI identification database (Unique Personal Identifier Database), which the EPR communities may access. The law regulates how the the EPR-SPID can be used. SR 816.111 states (Art. 10 para. 3 EPDV) that communities must ensure that the EPR-SPID number cannot be not stored in document repositories or document registries. | ||||||||
| Short | EPR-SPID | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..* | ||||||||
| Type | Identifier(EPR-SPID Identifier) | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||||||
| Pattern Value | { | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 216. Bundle.entry:Patient.resource.identifier:AHVN13 | |||||||||
| Slice Name | AHVN13 | ||||||||
| Definition | The AHVN13 / NAVS13 - (abbreviation for new thirteen-digit Social Security number) - is an administrative identifier for natural persons in Switzerland. It is issued, announced and administered by the Central Compensation Office. It is available to all organisations and communities for which there is a legal basis. | ||||||||
| Short | AHVN13 / NAVS13 of the patient (13 digits starting with 756, no separation points) | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..* | ||||||||
| Type | Identifier(AHVN13 / NAVS13 Identifier) | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||||||
| Pattern Value | { | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 218. Bundle.entry:Patient.resource.identifier:LocalPid | |||||||||
| Slice Name | LocalPid | ||||||||
| Definition | An identifier for this patient. | ||||||||
| Short | Local patient identifier(s) | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..* | ||||||||
| Type | Identifier | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||||||
| Pattern Value | { | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 220. Bundle.entry:Patient.resource.identifier:LocalPid.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 222. Bundle.entry:Patient.resource.identifier:LocalPid.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 224. Bundle.entry:Patient.resource.identifier:LocalPid.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..1 | ||||||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)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())) | ||||||||
| 226. Bundle.entry:Patient.resource.identifier:LocalPid.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 Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)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())) | ||||||||
| 228. Bundle.entry:Patient.resource.identifier:LocalPid.system | |||||||||
| Definition | Establishes the namespace for the value - that is, a 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. | ||||||||
| 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())) | ||||||||
| 230. Bundle.entry:Patient.resource.identifier:LocalPid.value | |||||||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||||||
| Short | The 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 Rendered Value extension. 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 | ||||||||
| 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())) | ||||||||
| 232. Bundle.entry:Patient.resource.identifier:LocalPid.period | |||||||||
| Definition | Time period during which identifier is/was valid for use. | ||||||||
| Short | Time period when id is/was valid for use | ||||||||
| Control | 0..1 | ||||||||
| 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())) | ||||||||
| 234. Bundle.entry:Patient.resource.identifier:LocalPid.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..1 | ||||||||
| 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())) | ||||||||
| 236. Bundle.entry:Patient.resource.identifier:insuranceCardNumber | |||||||||
| Slice Name | insuranceCardNumber | ||||||||
| Definition | Cardnumber Swiss insurance card v1 | ||||||||
| Short | Insurance card number of the patient (20 digits) | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..* | ||||||||
| Type | Identifier(Insurance Card Number (Identifier)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||||||
| Pattern Value | { | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 238. 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 | ||||||||
| 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())) | ||||||||
| 240. 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. | ||||||||
| Control | 0..* | ||||||||
| Type | HumanName(Human Name) | ||||||||
| Is Modifier | 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())) | ||||||||
| 242. 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 | ||||||||
| 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())) | ||||||||
| Slicing | This element introduces a set of slices on Bundle.entry.resource.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 244. 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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 246. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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 areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 248. 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 | 1..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|4.0.1)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())) | ||||||||
| 250. 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 | 1..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 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())) | ||||||||
| 252. 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|4.0.1)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())) | ||||||||
| 254. 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. | ||||||||
| 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())) | ||||||||
| 256. 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..1 | ||||||||
| 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())) | ||||||||
| 258. Bundle.entry:Patient.resource.telecom:email | |||||||||
| Slice Name | |||||||||
| 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(CH Core ContactPoint eCH-0046 Email) | ||||||||
| Is Modifier | 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())) | ||||||||
| 260. Bundle.entry:Patient.resource.telecom:email.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 262. Bundle.entry:Patient.resource.telecom:email.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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 areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 264. Bundle.entry:Patient.resource.telecom:email.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 | 1..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|4.0.1)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 | ||||||||
| Fixed Value | email | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 266. Bundle.entry:Patient.resource.telecom:email.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 | 1..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 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())) | ||||||||
| 268. Bundle.entry:Patient.resource.telecom:email.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|4.0.1)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())) | ||||||||
| 270. Bundle.entry:Patient.resource.telecom:email.use.id | |||||||||
| Definition | unique id for the element within a resource (for internal references) | ||||||||
| Short | xml:id (or equivalent in JSON) | ||||||||
| Control | 0..1 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 272. Bundle.entry:Patient.resource.telecom:email.use.extension | |||||||||
| Definition | An Extension | ||||||||
| Short | Extension | ||||||||
| Control | 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.telecom.use.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 274. Bundle.entry:Patient.resource.telecom:email.use.extension:emailCategory | |||||||||
| Slice Name | emailCategory | ||||||||
| Definition | Optional Extension Element - found in all resources. | ||||||||
| Short | Optional Extensions Element | ||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
| Type | Extension(eCH-0046 Email Category) (Extension Type: CodeableConcept) | ||||||||
| 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()) | ||||||||
| 276. Bundle.entry:Patient.resource.telecom:email.use.value | |||||||||
| Definition | Primitive value for code | ||||||||
| Short | Primitive value for code | ||||||||
| Control | 0..1 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 278. Bundle.entry:Patient.resource.telecom:email.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. | ||||||||
| 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())) | ||||||||
| 280. Bundle.entry:Patient.resource.telecom:email.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..1 | ||||||||
| 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())) | ||||||||
| 282. Bundle.entry:Patient.resource.telecom:email.period.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 284. Bundle.entry:Patient.resource.telecom:email.period.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 286. Bundle.entry:Patient.resource.telecom:email.period.start | |||||||||
| Definition | The start of the period. The boundary is inclusive. | ||||||||
| Short | Starting time with inclusive boundary | ||||||||
| Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||||||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||||||
| 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())) | ||||||||
| 288. Bundle.entry:Patient.resource.telecom:email.period.end | |||||||||
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||||||||
| Short | End time with inclusive boundary, if not ongoing | ||||||||
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | ||||||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||||||
| Type | dateTime | ||||||||
| Is Modifier | false | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Summary | true | ||||||||
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 290. Bundle.entry:Patient.resource.telecom:phone | |||||||||
| Slice Name | phone | ||||||||
| 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(CH Core ContactPoint eCH-0046 Phone) | ||||||||
| Is Modifier | 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())) | ||||||||
| 292. Bundle.entry:Patient.resource.telecom:phone.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 294. Bundle.entry:Patient.resource.telecom:phone.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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 areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 296. Bundle.entry:Patient.resource.telecom:phone.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 | 1..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|4.0.1)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 | ||||||||
| Fixed Value | phone | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 298. Bundle.entry:Patient.resource.telecom:phone.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 | 1..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 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())) | ||||||||
| 300. Bundle.entry:Patient.resource.telecom:phone.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|4.0.1)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())) | ||||||||
| 302. Bundle.entry:Patient.resource.telecom:phone.use.id | |||||||||
| Definition | unique id for the element within a resource (for internal references) | ||||||||
| Short | xml:id (or equivalent in JSON) | ||||||||
| Control | 0..1 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 304. Bundle.entry:Patient.resource.telecom:phone.use.extension | |||||||||
| Definition | An Extension | ||||||||
| Short | Extension | ||||||||
| Control | 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.telecom.use.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 306. Bundle.entry:Patient.resource.telecom:phone.use.extension:phoneCategory | |||||||||
| Slice Name | phoneCategory | ||||||||
| Definition | Optional Extension Element - found in all resources. | ||||||||
| Short | Optional Extensions Element | ||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
| Type | Extension(eCH-0046 Phone Category) (Extension Type: CodeableConcept) | ||||||||
| 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()) | ||||||||
| 308. Bundle.entry:Patient.resource.telecom:phone.use.value | |||||||||
| Definition | Primitive value for code | ||||||||
| Short | Primitive value for code | ||||||||
| Control | 0..1 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 310. Bundle.entry:Patient.resource.telecom:phone.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. | ||||||||
| 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())) | ||||||||
| 312. Bundle.entry:Patient.resource.telecom:phone.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..1 | ||||||||
| 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())) | ||||||||
| 314. Bundle.entry:Patient.resource.telecom:phone.period.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 316. Bundle.entry:Patient.resource.telecom:phone.period.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 318. Bundle.entry:Patient.resource.telecom:phone.period.start | |||||||||
| Definition | The start of the period. The boundary is inclusive. | ||||||||
| Short | Starting time with inclusive boundary | ||||||||
| Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||||||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||||||
| 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())) | ||||||||
| 320. Bundle.entry:Patient.resource.telecom:phone.period.end | |||||||||
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||||||||
| Short | End time with inclusive boundary, if not ongoing | ||||||||
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | ||||||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||||||
| Type | dateTime | ||||||||
| Is Modifier | false | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Summary | true | ||||||||
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 322. Bundle.entry:Patient.resource.telecom:internet | |||||||||
| Slice Name | internet | ||||||||
| 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(CH Core ContactPoint eCH-0046 Internet) | ||||||||
| Is Modifier | 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())) | ||||||||
| 324. Bundle.entry:Patient.resource.telecom:internet.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 326. Bundle.entry:Patient.resource.telecom:internet.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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 areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 328. Bundle.entry:Patient.resource.telecom:internet.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 | 1..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|4.0.1)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 | ||||||||
| Fixed Value | url | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 330. Bundle.entry:Patient.resource.telecom:internet.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 | 1..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 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())) | ||||||||
| 332. Bundle.entry:Patient.resource.telecom:internet.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|4.0.1)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())) | ||||||||
| 334. Bundle.entry:Patient.resource.telecom:internet.use.id | |||||||||
| Definition | unique id for the element within a resource (for internal references) | ||||||||
| Short | xml:id (or equivalent in JSON) | ||||||||
| Control | 0..1 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 336. Bundle.entry:Patient.resource.telecom:internet.use.extension | |||||||||
| Definition | An Extension | ||||||||
| Short | Extension | ||||||||
| Control | 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.telecom.use.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 338. Bundle.entry:Patient.resource.telecom:internet.use.extension:internetCategory | |||||||||
| Slice Name | internetCategory | ||||||||
| Definition | Optional Extension Element - found in all resources. | ||||||||
| Short | Optional Extensions Element | ||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
| Type | Extension(eCH-0046 Internet Category) (Extension Type: CodeableConcept) | ||||||||
| 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()) | ||||||||
| 340. Bundle.entry:Patient.resource.telecom:internet.use.value | |||||||||
| Definition | Primitive value for code | ||||||||
| Short | Primitive value for code | ||||||||
| Control | 0..1 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 342. Bundle.entry:Patient.resource.telecom:internet.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. | ||||||||
| 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())) | ||||||||
| 344. Bundle.entry:Patient.resource.telecom:internet.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..1 | ||||||||
| 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())) | ||||||||
| 346. Bundle.entry:Patient.resource.telecom:internet.period.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 348. Bundle.entry:Patient.resource.telecom:internet.period.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 350. Bundle.entry:Patient.resource.telecom:internet.period.start | |||||||||
| Definition | The start of the period. The boundary is inclusive. | ||||||||
| Short | Starting time with inclusive boundary | ||||||||
| Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||||||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||||||
| 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())) | ||||||||
| 352. Bundle.entry:Patient.resource.telecom:internet.period.end | |||||||||
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||||||||
| Short | End time with inclusive boundary, if not ongoing | ||||||||
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | ||||||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||||||
| Type | dateTime | ||||||||
| Is Modifier | false | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Summary | true | ||||||||
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 354. 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* (* see warning 'ch-pat-2') | ||||||||
| 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 | 0..1 | ||||||||
| Binding | The codes SHALL be taken from AdministrativeGender (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)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 | ||||||||
| 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())) | ||||||||
| 356. Bundle.entry:Patient.resource.birthDate | |||||||||
| Definition | The date of birth for the individual. | ||||||||
| Short | The date of birth for the individual | ||||||||
| Comments | At least an estimated year should be provided as a guess if the real DOB 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 | 0..1 | ||||||||
| Type | date | ||||||||
| Is Modifier | false | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| 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())) | ||||||||
| 358. 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 | Choice of: boolean, 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 | ||||||||
| 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())) | ||||||||
| 360. 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(CH Core Address) | ||||||||
| Is Modifier | 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())) | ||||||||
| 362. 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 | Unless not suitable, these codes SHALL be taken from ChCoreMaritalStatus (extensible to http://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus) | ||||||||
| Type | CodeableConcept | ||||||||
| Is Modifier | 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())) | ||||||||
| 364. Bundle.entry:Patient.resource.maritalStatus.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 366. Bundle.entry:Patient.resource.maritalStatus.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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.maritalStatus.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 368. Bundle.entry:Patient.resource.maritalStatus.extension:maritalDataSeparation | |||||||||
| Slice Name | maritalDataSeparation | ||||||||
| Definition | Extension for eCH-0011 - MaritalData - separation | ||||||||
| Short | MaritalData Separation | ||||||||
| Control | 0..1 | ||||||||
| Type | Extension(Marital Data - Separation Type) (Extension Type: CodeableConcept) | ||||||||
| 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()) | ||||||||
| 370. Bundle.entry:Patient.resource.maritalStatus.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())) | ||||||||
| 372. Bundle.entry:Patient.resource.maritalStatus.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())) | ||||||||
| 374. 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..1 | ||||||||
| Type | Choice of: boolean, integer | ||||||||
| [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 | ||||||||
| 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())) | ||||||||
| 376. Bundle.entry:Patient.resource.photo | |||||||||
| Definition | Image of the patient. | ||||||||
| Short | Image of the patient | ||||||||
| Comments | Guidelines:
| ||||||||
| Control | 0..* | ||||||||
| Type | Attachment | ||||||||
| Is Modifier | 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())) | ||||||||
| 378. 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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()) | ||||||||
| Slicing | This element introduces a set of slices on Bundle.entry.resource.contact. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||
| 380. Bundle.entry:Patient.resource.contact.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 382. Bundle.entry:Patient.resource.contact.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 384. Bundle.entry:Patient.resource.contact.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 386. Bundle.entry:Patient.resource.contact.relationship | |||||||||
| Definition | The nature of the relationship between the patient and the contact person. | ||||||||
| Short | The kind of relationship | ||||||||
| Control | 0..* | ||||||||
| Binding | Unless not suitable, these codes SHALL be taken from PatientContactRelationship (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1)The nature of the relationship between a patient and a contact person for that patient. | ||||||||
| Type | CodeableConcept | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 388. Bundle.entry:Patient.resource.contact.name | |||||||||
| Definition | A name associated with the contact person. | ||||||||
| Short | A name associated with the contact person | ||||||||
| Control | 0..1 | ||||||||
| Type | HumanName | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 390. Bundle.entry:Patient.resource.contact.telecom | |||||||||
| Definition | A contact detail for the person, e.g. a telephone number or an email address. | ||||||||
| Short | A contact detail for the person | ||||||||
| Comments | Contact 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. | ||||||||
| Control | 0..* | ||||||||
| Type | ContactPoint | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 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())) | ||||||||
| 392. Bundle.entry:Patient.resource.contact.address | |||||||||
| Definition | Address for the contact person. | ||||||||
| Short | Address for the contact person | ||||||||
| Control | 0..1 | ||||||||
| Type | Address | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 394. Bundle.entry:Patient.resource.contact.gender | |||||||||
| Definition | Administrative Gender - the gender that the contact 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|4.0.1)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 | ||||||||
| Summary | false | ||||||||
| 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())) | ||||||||
| 396. Bundle.entry:Patient.resource.contact.organization | |||||||||
| Definition | Organization on behalf of which the contact is acting or for which the contact is working. | ||||||||
| Short | Organization that is associated with the contact | ||||||||
| Control | 0..1 This element is affected by the following invariants: pat-1 | ||||||||
| Type | Reference(Organization) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | For guardians or business related contacts, the organization is relevant. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 398. Bundle.entry:Patient.resource.contact.period | |||||||||
| Definition | The period during which this contact person or organization is valid to be contacted relating to this patient. | ||||||||
| Short | The period during which this contact person or organization is valid to be contacted relating to this patient | ||||||||
| Control | 0..1 | ||||||||
| Type | Period | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 400. Bundle.entry:Patient.resource.contact:contact | |||||||||
| Slice Name | contact | ||||||||
| Definition | A contact party (e.g. guardian, partner, friend) for the patient. | ||||||||
| Short | Contact data if it is not the address of 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..1 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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()) | ||||||||
| 402. Bundle.entry:Patient.resource.contact:contact.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 404. Bundle.entry:Patient.resource.contact:contact.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 406. Bundle.entry:Patient.resource.contact:contact.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 408. Bundle.entry:Patient.resource.contact:contact.relationship | |||||||||
| Definition | The nature of the relationship between the patient and the contact person. | ||||||||
| Short | The kind of relationship | ||||||||
| Control | 1..1 | ||||||||
| Binding | Unless not suitable, these codes SHALL be taken from PatientContactRelationship (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1)The nature of the relationship between a patient and a contact person for that patient. | ||||||||
| Type | CodeableConcept | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||||||
| Pattern Value | { | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 410. Bundle.entry:Patient.resource.contact:contact.name | |||||||||
| Definition | A name associated with the contact person. | ||||||||
| Short | A name associated with the contact person | ||||||||
| Control | 0..1 | ||||||||
| Type | HumanName | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 412. Bundle.entry:Patient.resource.contact:contact.telecom | |||||||||
| Definition | A contact detail for the person, e.g. a telephone number or an email address. | ||||||||
| Short | A contact detail for the person | ||||||||
| Comments | Contact 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. | ||||||||
| Control | 0..0 | ||||||||
| Type | ContactPoint | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 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())) | ||||||||
| 414. Bundle.entry:Patient.resource.contact:contact.address | |||||||||
| Definition | Address for the contact person. | ||||||||
| Short | Address for the contact person | ||||||||
| Control | 1..1 | ||||||||
| Type | Address(CH Core Postal Address) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 416. Bundle.entry:Patient.resource.contact:contact.gender | |||||||||
| Definition | Administrative Gender - the gender that the contact 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|4.0.1)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 | ||||||||
| Summary | false | ||||||||
| 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())) | ||||||||
| 418. Bundle.entry:Patient.resource.contact:contact.organization | |||||||||
| Definition | Organization on behalf of which the contact is acting or for which the contact is working. | ||||||||
| Short | Organization that is associated with the contact | ||||||||
| Control | 0..1 This element is affected by the following invariants: pat-1 | ||||||||
| Type | Reference(Organization) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | For guardians or business related contacts, the organization is relevant. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 420. Bundle.entry:Patient.resource.contact:contact.period | |||||||||
| Definition | The period during which this contact person or organization is valid to be contacted relating to this patient. | ||||||||
| Short | The period during which this contact person or organization is valid to be contacted relating to this patient | ||||||||
| Control | 0..1 | ||||||||
| Type | Period | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 422. Bundle.entry:Patient.resource.contact:nameOfParent | |||||||||
| Slice Name | nameOfParent | ||||||||
| Definition | A contact party (e.g. guardian, partner, friend) for the patient. | ||||||||
| Short | Name of parent | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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()) | ||||||||
| 424. Bundle.entry:Patient.resource.contact:nameOfParent.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 426. Bundle.entry:Patient.resource.contact:nameOfParent.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 428. Bundle.entry:Patient.resource.contact:nameOfParent.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 430. Bundle.entry:Patient.resource.contact:nameOfParent.relationship | |||||||||
| Definition | The nature of the relationship between the patient and the contact person. | ||||||||
| Short | The kind of relationship | ||||||||
| Control | 1..1 | ||||||||
| Binding | Unless not suitable, these codes SHALL be taken from PatientContactRelationship (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1)The nature of the relationship between a patient and a contact person for that patient. | ||||||||
| Type | CodeableConcept | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||||||
| Pattern Value | { | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 432. Bundle.entry:Patient.resource.contact:nameOfParent.name | |||||||||
| Definition | A name associated with the contact person. | ||||||||
| Short | A name associated with the contact person | ||||||||
| Control | 1..1 | ||||||||
| Type | HumanName | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 434. Bundle.entry:Patient.resource.contact:nameOfParent.telecom | |||||||||
| Definition | A contact detail for the person, e.g. a telephone number or an email address. | ||||||||
| Short | A contact detail for the person | ||||||||
| Comments | Contact 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. | ||||||||
| Control | 0..* | ||||||||
| Type | ContactPoint | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 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())) | ||||||||
| 436. Bundle.entry:Patient.resource.contact:nameOfParent.address | |||||||||
| Definition | Address for the contact person. | ||||||||
| Short | Address for the contact person | ||||||||
| Control | 0..1 | ||||||||
| Type | Address | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 438. Bundle.entry:Patient.resource.contact:nameOfParent.gender | |||||||||
| Definition | Administrative Gender - the gender that the contact 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|4.0.1)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 | ||||||||
| Summary | false | ||||||||
| 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())) | ||||||||
| 440. Bundle.entry:Patient.resource.contact:nameOfParent.organization | |||||||||
| Definition | Organization on behalf of which the contact is acting or for which the contact is working. | ||||||||
| Short | Organization that is associated with the contact | ||||||||
| Control | 0..1 This element is affected by the following invariants: pat-1 | ||||||||
| Type | Reference(Organization) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | For guardians or business related contacts, the organization is relevant. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 442. Bundle.entry:Patient.resource.contact:nameOfParent.period | |||||||||
| Definition | The period during which this contact person or organization is valid to be contacted relating to this patient. | ||||||||
| Short | The period during which this contact person or organization is valid to be contacted relating to this patient | ||||||||
| Control | 0..1 | ||||||||
| Type | Period | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 444. 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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())) | ||||||||
| 446. Bundle.entry:Patient.resource.communication.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 448. Bundle.entry:Patient.resource.communication.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 450. Bundle.entry:Patient.resource.communication.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 452. Bundle.entry:Patient.resource.communication.language | |||||||||
| Definition | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. | ||||||||
| Short | The language which can be used to communicate with the patient about his or her health | ||||||||
| Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. | ||||||||
| Control | 1..1 | ||||||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||||||
| Type | CodeableConcept | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | false | ||||||||
| Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 454. Bundle.entry:Patient.resource.communication.preferred | |||||||||
| Definition | Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). | ||||||||
| Short | Language preference indicator | ||||||||
| Comments | This language is specifically identified for communicating healthcare information. | ||||||||
| Control | 0..1 | ||||||||
| Type | boolean | ||||||||
| Is Modifier | false | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Summary | false | ||||||||
| Requirements | People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 456. 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..* | ||||||||
| Type | Reference(Organization, Practitioner, PractitionerRole) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | careProvider | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 458. 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..1 | ||||||||
| Type | Reference(Organization) | ||||||||
| Is Modifier | 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())) | ||||||||
| 460. Bundle.entry:Patient.resource.link | |||||||||
| Definition | Link to another patient resource that concerns the same actual patient. | ||||||||
| Short | Link to another patient resource that concerns the same actual person | ||||||||
| Comments | There is no assumption that linked patient records have mutual links. | ||||||||
| Control | 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' | ||||||||
| 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())) | ||||||||
| 462. Bundle.entry:Patient.resource.link.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 464. Bundle.entry:Patient.resource.link.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 466. Bundle.entry:Patient.resource.link.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 468. Bundle.entry:Patient.resource.link.other | |||||||||
| Definition | The other patient resource that the link refers to. | ||||||||
| Short | The other patient or related person resource that the link refers to | ||||||||
| Comments | Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. | ||||||||
| Control | 1..1 | ||||||||
| Type | Reference(Patient, RelatedPerson) | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 470. Bundle.entry:Patient.resource.link.type | |||||||||
| Definition | The type of link between this patient resource and another patient resource. | ||||||||
| Short | replaced-by | replaces | refer | seealso | ||||||||
| Control | 1..1 | ||||||||
| Binding | The codes SHALL be taken from LinkType (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)The type of link between this patient resource and another patient resource. | ||||||||
| 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())) | ||||||||
| 472. Bundle.entry:Patient.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 474. Bundle.entry:Patient.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 476. Bundle.entry:Patient.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 478. Bundle.entry:Patient.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 480. Bundle.entry:Patient.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 482. Bundle.entry:Patient.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 484. 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 | 0..1 This element is affected by the following invariants: bdl-3 | ||||||||
| Type | BackboneElement | ||||||||
| 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: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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 488. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 490. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 492. 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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 494. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 496. 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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 498. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 500. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 502. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 504. 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..1 This element is affected by the following invariants: bdl-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 506. Bundle.entry:Patient.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 508. Bundle.entry:Patient.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 510. Bundle.entry:Patient.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 512. Bundle.entry:Patient.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 514. Bundle.entry:Patient.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 516. Bundle.entry:Patient.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 518. Bundle.entry:Patient.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 520. Bundle.entry:Patient.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 | ||||||||
| Summary | true | ||||||||
| 522. 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 524. 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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 526. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 528. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 530. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 532. Bundle.entry:Practitioner.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 534. Bundle.entry:Practitioner.resource | |||||||||
| Definition | The CH Core Practitioner is based upon the core FHIR Practitioner Resource and designed to meet the applicable practitioner demographic data elements in Switzerland. See also https://www.bfs.admin.ch/bfs/de/home/register/personenregister/registerharmonisierung/nomenklaturen.html for further information | ||||||||
| Short | CH IPS Practitioner | ||||||||
| Control | 1..1 | ||||||||
| Type | Practitioner(CH IPS Practitioner) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 536. Bundle.entry:Practitioner.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 538. Bundle.entry:Practitioner.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 540. Bundle.entry:Practitioner.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 542. Bundle.entry:Practitioner.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 544. Bundle.entry:Practitioner.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 546. Bundle.entry:Practitioner.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 548. 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 | 0..1 This element is affected by the following invariants: bdl-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 550. 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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 552. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 554. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 556. 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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 558. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 560. 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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 562. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 564. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 566. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 568. 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..1 This element is affected by the following invariants: bdl-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 570. Bundle.entry:Practitioner.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 572. Bundle.entry:Practitioner.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 574. Bundle.entry:Practitioner.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 576. Bundle.entry:Practitioner.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 578. Bundle.entry:Practitioner.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 580. Bundle.entry:Practitioner.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 582. Bundle.entry:Practitioner.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 584. Bundle.entry:Practitioner.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 | ||||||||
| Summary | true | ||||||||
| 586. Bundle.entry:PractitionerRole | |||||||||
| Slice Name | PractitionerRole | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 588. Bundle.entry:PractitionerRole.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 590. Bundle.entry:PractitionerRole.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 592. Bundle.entry:PractitionerRole.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 594. Bundle.entry:PractitionerRole.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 596. Bundle.entry:PractitionerRole.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 598. Bundle.entry:PractitionerRole.resource | |||||||||
| Definition | A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. | ||||||||
| Short | CH IPS PractitionerRole | ||||||||
| Control | 1..1 | ||||||||
| Type | PractitionerRole(CH IPS PractitionerRole) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 600. Bundle.entry:PractitionerRole.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 602. Bundle.entry:PractitionerRole.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 604. Bundle.entry:PractitionerRole.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 606. Bundle.entry:PractitionerRole.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 608. Bundle.entry:PractitionerRole.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 610. Bundle.entry:PractitionerRole.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 612. Bundle.entry:PractitionerRole.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 614. Bundle.entry:PractitionerRole.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 616. Bundle.entry:PractitionerRole.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 618. Bundle.entry:PractitionerRole.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 620. Bundle.entry:PractitionerRole.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 622. Bundle.entry:PractitionerRole.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 624. Bundle.entry:PractitionerRole.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 626. Bundle.entry:PractitionerRole.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 628. Bundle.entry:PractitionerRole.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 630. Bundle.entry:PractitionerRole.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 632. Bundle.entry:PractitionerRole.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 634. Bundle.entry:PractitionerRole.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 636. Bundle.entry:PractitionerRole.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 638. Bundle.entry:PractitionerRole.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 640. Bundle.entry:PractitionerRole.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 642. Bundle.entry:PractitionerRole.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 644. Bundle.entry:PractitionerRole.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 646. Bundle.entry:PractitionerRole.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 648. Bundle.entry:PractitionerRole.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 | ||||||||
| Summary | true | ||||||||
| 650. 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 652. 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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 654. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 656. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 658. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 660. Bundle.entry:Organization.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 662. 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 | CH IPS Organization | ||||||||
| Control | 1..1 | ||||||||
| Type | Organization(CH IPS Organization) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 664. Bundle.entry:Organization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 666. Bundle.entry:Organization.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 668. Bundle.entry:Organization.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 670. Bundle.entry:Organization.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 672. Bundle.entry:Organization.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 674. Bundle.entry:Organization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 676. 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 | 0..1 This element is affected by the following invariants: bdl-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 678. 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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 680. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 682. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 684. 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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 686. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 688. 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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 690. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 692. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 694. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 696. 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..1 This element is affected by the following invariants: bdl-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 698. Bundle.entry:Organization.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 700. Bundle.entry:Organization.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 702. Bundle.entry:Organization.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 704. Bundle.entry:Organization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 706. Bundle.entry:Organization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 708. Bundle.entry:Organization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 710. Bundle.entry:Organization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 712. Bundle.entry:Organization.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 | ||||||||
| Summary | true | ||||||||
| 714. Bundle.entry:RelatedPerson | |||||||||
| Slice Name | RelatedPerson | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 716. Bundle.entry:RelatedPerson.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 718. Bundle.entry:RelatedPerson.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 720. Bundle.entry:RelatedPerson.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 722. Bundle.entry:RelatedPerson.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 724. Bundle.entry:RelatedPerson.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 726. Bundle.entry:RelatedPerson.resource | |||||||||
| Definition | Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. | ||||||||
| Short | CH Core RelatedPerson | ||||||||
| Control | 1..1 | ||||||||
| Type | RelatedPerson(CH Emergency Record RelatedPerson) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 728. Bundle.entry:RelatedPerson.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 730. Bundle.entry:RelatedPerson.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 732. Bundle.entry:RelatedPerson.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 734. Bundle.entry:RelatedPerson.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 736. Bundle.entry:RelatedPerson.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 738. Bundle.entry:RelatedPerson.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 740. Bundle.entry:RelatedPerson.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 742. Bundle.entry:RelatedPerson.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 744. Bundle.entry:RelatedPerson.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 746. Bundle.entry:RelatedPerson.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 748. Bundle.entry:RelatedPerson.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 750. Bundle.entry:RelatedPerson.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 752. Bundle.entry:RelatedPerson.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 754. Bundle.entry:RelatedPerson.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 756. Bundle.entry:RelatedPerson.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 758. Bundle.entry:RelatedPerson.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 760. Bundle.entry:RelatedPerson.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 762. Bundle.entry:RelatedPerson.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 764. Bundle.entry:RelatedPerson.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 766. Bundle.entry:RelatedPerson.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 768. Bundle.entry:RelatedPerson.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 770. Bundle.entry:RelatedPerson.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 772. Bundle.entry:RelatedPerson.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 774. Bundle.entry:RelatedPerson.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 776. Bundle.entry:RelatedPerson.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 | ||||||||
| Summary | true | ||||||||
| 778. Bundle.entry:Device | |||||||||
| Slice Name | Device | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 780. Bundle.entry:Device.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 782. Bundle.entry:Device.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 784. Bundle.entry:Device.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 786. Bundle.entry:Device.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 788. Bundle.entry:Device.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 790. Bundle.entry:Device.resource | |||||||||
| Definition | A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. | ||||||||
| Short | Item used in healthcare | ||||||||
| Control | 1..1 | ||||||||
| Type | Device(Device) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 792. Bundle.entry:Device.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 794. Bundle.entry:Device.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 796. Bundle.entry:Device.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 798. Bundle.entry:Device.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 800. Bundle.entry:Device.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 802. Bundle.entry:Device.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 804. Bundle.entry:Device.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 806. Bundle.entry:Device.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 808. Bundle.entry:Device.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 810. Bundle.entry:Device.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 812. Bundle.entry:Device.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 814. Bundle.entry:Device.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 816. Bundle.entry:Device.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 818. Bundle.entry:Device.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 820. Bundle.entry:Device.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 822. Bundle.entry:Device.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 824. Bundle.entry:Device.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 826. Bundle.entry:Device.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 828. Bundle.entry:Device.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 830. Bundle.entry:Device.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 832. Bundle.entry:Device.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 834. Bundle.entry:Device.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 836. Bundle.entry:Device.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 838. Bundle.entry:Device.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 840. Bundle.entry:Device.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 | ||||||||
| Summary | true | ||||||||
| 842. Bundle.entry:Encounter | |||||||||
| Slice Name | Encounter | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 844. Bundle.entry:Encounter.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 846. Bundle.entry:Encounter.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 848. Bundle.entry:Encounter.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 850. Bundle.entry:Encounter.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 852. Bundle.entry:Encounter.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 854. Bundle.entry:Encounter.resource | |||||||||
| Definition | This is basic constraint on Encounter for use in CH Core resources. | ||||||||
| Short | CH Core Encounter | ||||||||
| Control | 1..1 | ||||||||
| Type | Resource(CH Core Encounter) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Visit | ||||||||
| 856. Bundle.entry:Encounter.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 858. Bundle.entry:Encounter.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 860. Bundle.entry:Encounter.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 862. Bundle.entry:Encounter.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 864. Bundle.entry:Encounter.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 866. Bundle.entry:Encounter.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 868. Bundle.entry:Encounter.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 870. Bundle.entry:Encounter.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 872. Bundle.entry:Encounter.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 874. Bundle.entry:Encounter.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 876. Bundle.entry:Encounter.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 878. Bundle.entry:Encounter.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 880. Bundle.entry:Encounter.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 882. Bundle.entry:Encounter.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 884. Bundle.entry:Encounter.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 886. Bundle.entry:Encounter.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 888. Bundle.entry:Encounter.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 890. Bundle.entry:Encounter.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 892. Bundle.entry:Encounter.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 894. Bundle.entry:Encounter.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 896. Bundle.entry:Encounter.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 898. Bundle.entry:Encounter.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 900. Bundle.entry:Encounter.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 902. Bundle.entry:Encounter.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 904. Bundle.entry:Encounter.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 | ||||||||
| Summary | true | ||||||||
| 906. Bundle.entry:Location | |||||||||
| Slice Name | Location | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 908. Bundle.entry:Location.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 910. Bundle.entry:Location.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 912. Bundle.entry:Location.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 914. Bundle.entry:Location.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 916. Bundle.entry:Location.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 918. Bundle.entry:Location.resource | |||||||||
| Definition | Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. | ||||||||
| Short | CH Core Location | ||||||||
| Control | 1..1 | ||||||||
| Type | Resource(CH Core Location) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 920. Bundle.entry:Location.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 922. Bundle.entry:Location.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 924. Bundle.entry:Location.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 926. Bundle.entry:Location.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 928. Bundle.entry:Location.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 930. Bundle.entry:Location.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 932. Bundle.entry:Location.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 934. Bundle.entry:Location.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 936. Bundle.entry:Location.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 938. Bundle.entry:Location.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 940. Bundle.entry:Location.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 942. Bundle.entry:Location.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 944. Bundle.entry:Location.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 946. Bundle.entry:Location.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 948. Bundle.entry:Location.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 950. Bundle.entry:Location.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 952. Bundle.entry:Location.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 954. Bundle.entry:Location.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 956. Bundle.entry:Location.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 958. Bundle.entry:Location.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 960. Bundle.entry:Location.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 962. Bundle.entry:Location.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 964. Bundle.entry:Location.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 966. Bundle.entry:Location.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 968. Bundle.entry:Location.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 | ||||||||
| Summary | true | ||||||||
| 970. Bundle.entry:AllergyIntolerance | |||||||||
| Slice Name | AllergyIntolerance | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 972. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 974. Bundle.entry:AllergyIntolerance.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 976. Bundle.entry:AllergyIntolerance.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 978. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 980. Bundle.entry:AllergyIntolerance.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 982. Bundle.entry:AllergyIntolerance.resource | |||||||||
| Definition | Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance. | ||||||||
| Short | CH IPS AllergyIntolerance | ||||||||
| Comments | Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings. | ||||||||
| Control | 1..1 | ||||||||
| Type | AllergyIntolerance(CH IPS AllergyIntolerance) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Allergy, Intolerance, Adverse Reaction | ||||||||
| 984. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 986. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 988. Bundle.entry:AllergyIntolerance.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 990. Bundle.entry:AllergyIntolerance.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 992. Bundle.entry:AllergyIntolerance.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 994. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 996. Bundle.entry:AllergyIntolerance.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 998. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1000. Bundle.entry:AllergyIntolerance.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1002. Bundle.entry:AllergyIntolerance.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1004. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1006. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1008. Bundle.entry:AllergyIntolerance.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1010. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1012. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1014. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1016. Bundle.entry:AllergyIntolerance.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1018. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1020. Bundle.entry:AllergyIntolerance.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1022. Bundle.entry:AllergyIntolerance.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1024. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1026. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1028. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1030. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1032. Bundle.entry:AllergyIntolerance.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 | ||||||||
| Summary | true | ||||||||
| 1034. Bundle.entry:Condition | |||||||||
| Slice Name | Condition | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 1036. Bundle.entry:Condition.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1038. Bundle.entry:Condition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1040. Bundle.entry:Condition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1042. Bundle.entry:Condition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1044. Bundle.entry:Condition.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 1046. Bundle.entry:Condition.resource | |||||||||
| Definition | A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. | ||||||||
| Short | CH IPS Condition | ||||||||
| Control | 1..1 | ||||||||
| Type | Condition(CH IPS Condition) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 1048. Bundle.entry:Condition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1050. Bundle.entry:Condition.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1052. Bundle.entry:Condition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1054. Bundle.entry:Condition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1056. Bundle.entry:Condition.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1058. Bundle.entry:Condition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1060. Bundle.entry:Condition.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1062. Bundle.entry:Condition.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1064. Bundle.entry:Condition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1066. Bundle.entry:Condition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1068. Bundle.entry:Condition.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1070. Bundle.entry:Condition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1072. Bundle.entry:Condition.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1074. Bundle.entry:Condition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1076. Bundle.entry:Condition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1078. Bundle.entry:Condition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1080. Bundle.entry:Condition.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1082. Bundle.entry:Condition.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1084. Bundle.entry:Condition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1086. Bundle.entry:Condition.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1088. Bundle.entry:Condition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1090. Bundle.entry:Condition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1092. Bundle.entry:Condition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1094. Bundle.entry:Condition.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1096. Bundle.entry:Condition.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 | ||||||||
| Summary | true | ||||||||
| 1098. Bundle.entry:DeviceUseStatement | |||||||||
| Slice Name | DeviceUseStatement | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 1100. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1102. Bundle.entry:DeviceUseStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1104. Bundle.entry:DeviceUseStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1106. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1108. Bundle.entry:DeviceUseStatement.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 1110. Bundle.entry:DeviceUseStatement.resource | |||||||||
| Definition | A record of a device being used by a patient where the record is the result of a report from the patient or another clinician. | ||||||||
| Short | Record of use of a device | ||||||||
| Control | 1..1 | ||||||||
| Type | DeviceUseStatement(DeviceUseStatement (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 1112. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1114. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1116. Bundle.entry:DeviceUseStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1118. Bundle.entry:DeviceUseStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1120. Bundle.entry:DeviceUseStatement.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1122. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1124. Bundle.entry:DeviceUseStatement.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1126. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1128. Bundle.entry:DeviceUseStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1130. Bundle.entry:DeviceUseStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1132. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1134. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1136. Bundle.entry:DeviceUseStatement.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1138. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1140. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1142. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1144. Bundle.entry:DeviceUseStatement.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1146. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1148. Bundle.entry:DeviceUseStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1150. Bundle.entry:DeviceUseStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1152. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1154. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1156. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1158. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1160. Bundle.entry:DeviceUseStatement.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 | ||||||||
| Summary | true | ||||||||
| 1162. Bundle.entry:DiagnosticReport | |||||||||
| Slice Name | DiagnosticReport | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 1164. Bundle.entry:DiagnosticReport.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1166. Bundle.entry:DiagnosticReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1168. Bundle.entry:DiagnosticReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1170. Bundle.entry:DiagnosticReport.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1172. Bundle.entry:DiagnosticReport.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 1174. Bundle.entry:DiagnosticReport.resource | |||||||||
| Definition | The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. | ||||||||
| Short | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | ||||||||
| Comments | This is intended to capture a single report and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing. | ||||||||
| Control | 1..1 | ||||||||
| Type | DiagnosticReport(DiagnosticReport (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Report, Test, Result, Results, Labs, Laboratory | ||||||||
| 1176. Bundle.entry:DiagnosticReport.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1178. Bundle.entry:DiagnosticReport.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1180. Bundle.entry:DiagnosticReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1182. Bundle.entry:DiagnosticReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1184. Bundle.entry:DiagnosticReport.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1186. Bundle.entry:DiagnosticReport.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1188. Bundle.entry:DiagnosticReport.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1190. Bundle.entry:DiagnosticReport.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1192. Bundle.entry:DiagnosticReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1194. Bundle.entry:DiagnosticReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1196. Bundle.entry:DiagnosticReport.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1198. Bundle.entry:DiagnosticReport.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1200. Bundle.entry:DiagnosticReport.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1202. Bundle.entry:DiagnosticReport.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1204. Bundle.entry:DiagnosticReport.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1206. Bundle.entry:DiagnosticReport.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1208. Bundle.entry:DiagnosticReport.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1210. Bundle.entry:DiagnosticReport.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1212. Bundle.entry:DiagnosticReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1214. Bundle.entry:DiagnosticReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1216. Bundle.entry:DiagnosticReport.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1218. Bundle.entry:DiagnosticReport.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1220. Bundle.entry:DiagnosticReport.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1222. Bundle.entry:DiagnosticReport.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1224. Bundle.entry:DiagnosticReport.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 | ||||||||
| Summary | true | ||||||||
| 1226. Bundle.entry:ImagingStudy | |||||||||
| Slice Name | ImagingStudy | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 1228. Bundle.entry:ImagingStudy.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1230. Bundle.entry:ImagingStudy.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1232. Bundle.entry:ImagingStudy.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1234. Bundle.entry:ImagingStudy.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1236. Bundle.entry:ImagingStudy.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 1238. Bundle.entry:ImagingStudy.resource | |||||||||
| Definition | Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities. | ||||||||
| Short | A set of images produced in single study (one or more series of references images) | ||||||||
| Control | 1..1 | ||||||||
| Type | ImagingStudy(ImagingStudy (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 1240. Bundle.entry:ImagingStudy.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1242. Bundle.entry:ImagingStudy.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1244. Bundle.entry:ImagingStudy.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1246. Bundle.entry:ImagingStudy.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1248. Bundle.entry:ImagingStudy.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1250. Bundle.entry:ImagingStudy.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1252. Bundle.entry:ImagingStudy.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1254. Bundle.entry:ImagingStudy.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1256. Bundle.entry:ImagingStudy.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1258. Bundle.entry:ImagingStudy.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1260. Bundle.entry:ImagingStudy.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1262. Bundle.entry:ImagingStudy.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1264. Bundle.entry:ImagingStudy.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1266. Bundle.entry:ImagingStudy.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1268. Bundle.entry:ImagingStudy.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1270. Bundle.entry:ImagingStudy.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1272. Bundle.entry:ImagingStudy.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1274. Bundle.entry:ImagingStudy.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1276. Bundle.entry:ImagingStudy.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1278. Bundle.entry:ImagingStudy.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1280. Bundle.entry:ImagingStudy.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1282. Bundle.entry:ImagingStudy.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1284. Bundle.entry:ImagingStudy.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1286. Bundle.entry:ImagingStudy.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1288. Bundle.entry:ImagingStudy.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 | ||||||||
| Summary | true | ||||||||
| 1290. Bundle.entry:Immunization | |||||||||
| Slice Name | Immunization | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 1292. Bundle.entry:Immunization.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1294. Bundle.entry:Immunization.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1296. Bundle.entry:Immunization.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1298. Bundle.entry:Immunization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1300. Bundle.entry:Immunization.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 1302. Bundle.entry:Immunization.resource | |||||||||
| Definition | Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party. | ||||||||
| Short | CH IPS Immunization | ||||||||
| Control | 1..1 | ||||||||
| Type | Immunization(CH IPS Immunization) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 1304. Bundle.entry:Immunization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1306. Bundle.entry:Immunization.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1308. Bundle.entry:Immunization.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1310. Bundle.entry:Immunization.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1312. Bundle.entry:Immunization.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1314. Bundle.entry:Immunization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1316. Bundle.entry:Immunization.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1318. Bundle.entry:Immunization.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1320. Bundle.entry:Immunization.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1322. Bundle.entry:Immunization.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1324. Bundle.entry:Immunization.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1326. Bundle.entry:Immunization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1328. Bundle.entry:Immunization.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1330. Bundle.entry:Immunization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1332. Bundle.entry:Immunization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1334. Bundle.entry:Immunization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1336. Bundle.entry:Immunization.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1338. Bundle.entry:Immunization.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1340. Bundle.entry:Immunization.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1342. Bundle.entry:Immunization.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1344. Bundle.entry:Immunization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1346. Bundle.entry:Immunization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1348. Bundle.entry:Immunization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1350. Bundle.entry:Immunization.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1352. Bundle.entry:Immunization.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 | ||||||||
| Summary | true | ||||||||
| 1354. Bundle.entry:Medication | |||||||||
| Slice Name | Medication | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 1356. Bundle.entry:Medication.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1358. Bundle.entry:Medication.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1360. Bundle.entry:Medication.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1362. Bundle.entry:Medication.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1364. Bundle.entry:Medication.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 1366. Bundle.entry:Medication.resource | |||||||||
| Definition | This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. | ||||||||
| Short | CH IPS Medication | ||||||||
| Control | 1..1 | ||||||||
| Type | Medication(CH IPS Medication) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 1368. Bundle.entry:Medication.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1370. Bundle.entry:Medication.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1372. Bundle.entry:Medication.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1374. Bundle.entry:Medication.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1376. Bundle.entry:Medication.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1378. Bundle.entry:Medication.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1380. Bundle.entry:Medication.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1382. Bundle.entry:Medication.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1384. Bundle.entry:Medication.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1386. Bundle.entry:Medication.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1388. Bundle.entry:Medication.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1390. Bundle.entry:Medication.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1392. Bundle.entry:Medication.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1394. Bundle.entry:Medication.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1396. Bundle.entry:Medication.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1398. Bundle.entry:Medication.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1400. Bundle.entry:Medication.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1402. Bundle.entry:Medication.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1404. Bundle.entry:Medication.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1406. Bundle.entry:Medication.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1408. Bundle.entry:Medication.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1410. Bundle.entry:Medication.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1412. Bundle.entry:Medication.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1414. Bundle.entry:Medication.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1416. Bundle.entry:Medication.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 | ||||||||
| Summary | true | ||||||||
| 1418. Bundle.entry:MedicationRequest | |||||||||
| Slice Name | MedicationRequest | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 1420. Bundle.entry:MedicationRequest.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1422. Bundle.entry:MedicationRequest.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1424. Bundle.entry:MedicationRequest.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1426. Bundle.entry:MedicationRequest.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1428. Bundle.entry:MedicationRequest.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 1430. Bundle.entry:MedicationRequest.resource | |||||||||
| Definition | An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns. | ||||||||
| Short | CH IPS MedicationRequest | ||||||||
| Control | 1..1 | ||||||||
| Type | MedicationRequest(CH IPS MedicationRequest) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Prescription, Order | ||||||||
| 1432. Bundle.entry:MedicationRequest.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1434. Bundle.entry:MedicationRequest.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1436. Bundle.entry:MedicationRequest.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1438. Bundle.entry:MedicationRequest.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1440. Bundle.entry:MedicationRequest.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1442. Bundle.entry:MedicationRequest.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1444. Bundle.entry:MedicationRequest.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1446. Bundle.entry:MedicationRequest.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1448. Bundle.entry:MedicationRequest.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1450. Bundle.entry:MedicationRequest.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1452. Bundle.entry:MedicationRequest.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1454. Bundle.entry:MedicationRequest.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1456. Bundle.entry:MedicationRequest.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1458. Bundle.entry:MedicationRequest.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1460. Bundle.entry:MedicationRequest.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1462. Bundle.entry:MedicationRequest.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1464. Bundle.entry:MedicationRequest.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1466. Bundle.entry:MedicationRequest.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1468. Bundle.entry:MedicationRequest.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1470. Bundle.entry:MedicationRequest.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1472. Bundle.entry:MedicationRequest.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1474. Bundle.entry:MedicationRequest.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1476. Bundle.entry:MedicationRequest.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1478. Bundle.entry:MedicationRequest.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1480. Bundle.entry:MedicationRequest.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 | ||||||||
| Summary | true | ||||||||
| 1482. Bundle.entry:MedicationStatement | |||||||||
| Slice Name | MedicationStatement | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 1484. Bundle.entry:MedicationStatement.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1486. Bundle.entry:MedicationStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1488. Bundle.entry:MedicationStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1490. Bundle.entry:MedicationStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1492. Bundle.entry:MedicationStatement.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 1494. Bundle.entry:MedicationStatement.resource | |||||||||
| Definition | A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information. | ||||||||
| Short | CH IPS MedicationStatement | ||||||||
| Comments | When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered: MedicationStatement.status + MedicationStatement.wasNotTaken Status=Active + NotTaken=T = Not currently taking Status=Completed + NotTaken=T = Not taken in the past Status=Intended + NotTaken=T = No intention of taking Status=Active + NotTaken=F = Taking, but not as prescribed Status=Active + NotTaken=F = Taking Status=Intended +NotTaken= F = Will be taking (not started) Status=Completed + NotTaken=F = Taken in past Status=In Error + NotTaken=N/A = In Error. | ||||||||
| Control | 1..1 | ||||||||
| Type | MedicationStatement(CH IPS MedicationStatement) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 1496. Bundle.entry:MedicationStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1498. Bundle.entry:MedicationStatement.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1500. Bundle.entry:MedicationStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1502. Bundle.entry:MedicationStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1504. Bundle.entry:MedicationStatement.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1506. Bundle.entry:MedicationStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1508. Bundle.entry:MedicationStatement.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1510. Bundle.entry:MedicationStatement.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1512. Bundle.entry:MedicationStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1514. Bundle.entry:MedicationStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1516. Bundle.entry:MedicationStatement.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1518. Bundle.entry:MedicationStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1520. Bundle.entry:MedicationStatement.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1522. Bundle.entry:MedicationStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1524. Bundle.entry:MedicationStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1526. Bundle.entry:MedicationStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1528. Bundle.entry:MedicationStatement.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1530. Bundle.entry:MedicationStatement.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1532. Bundle.entry:MedicationStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1534. Bundle.entry:MedicationStatement.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1536. Bundle.entry:MedicationStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1538. Bundle.entry:MedicationStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1540. Bundle.entry:MedicationStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1542. Bundle.entry:MedicationStatement.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1544. Bundle.entry:MedicationStatement.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 | ||||||||
| Summary | true | ||||||||
| 1546. Bundle.entry:Procedure | |||||||||
| Slice Name | Procedure | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 1548. Bundle.entry:Procedure.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1550. Bundle.entry:Procedure.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1552. Bundle.entry:Procedure.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1554. Bundle.entry:Procedure.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1556. Bundle.entry:Procedure.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 1558. Bundle.entry:Procedure.resource | |||||||||
| Definition | An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy. | ||||||||
| Short | An action that is being or was performed on a patient | ||||||||
| Control | 1..1 | ||||||||
| Type | Procedure(Procedure (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 1560. Bundle.entry:Procedure.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1562. Bundle.entry:Procedure.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1564. Bundle.entry:Procedure.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1566. Bundle.entry:Procedure.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1568. Bundle.entry:Procedure.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1570. Bundle.entry:Procedure.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1572. Bundle.entry:Procedure.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1574. Bundle.entry:Procedure.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1576. Bundle.entry:Procedure.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1578. Bundle.entry:Procedure.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1580. Bundle.entry:Procedure.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1582. Bundle.entry:Procedure.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1584. Bundle.entry:Procedure.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1586. Bundle.entry:Procedure.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1588. Bundle.entry:Procedure.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1590. Bundle.entry:Procedure.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1592. Bundle.entry:Procedure.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1594. Bundle.entry:Procedure.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1596. Bundle.entry:Procedure.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1598. Bundle.entry:Procedure.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1600. Bundle.entry:Procedure.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1602. Bundle.entry:Procedure.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1604. Bundle.entry:Procedure.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1606. Bundle.entry:Procedure.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1608. Bundle.entry:Procedure.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 | ||||||||
| Summary | true | ||||||||
| 1610. Bundle.entry:ObservationPregnancyEdd | |||||||||
| Slice Name | ObservationPregnancyEdd | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 1612. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1614. Bundle.entry:ObservationPregnancyEdd.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1616. Bundle.entry:ObservationPregnancyEdd.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1618. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1620. Bundle.entry:ObservationPregnancyEdd.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 1622. Bundle.entry:ObservationPregnancyEdd.resource | |||||||||
| Definition | Measurements and simple assertions made about a patient, device or other subject. | ||||||||
| Short | Measurements and simple assertions | ||||||||
| Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. | ||||||||
| Control | 1..1 | ||||||||
| Type | Observation(Observation Pregnancy - Expected Delivery Date (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||||||
| 1624. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1626. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1628. Bundle.entry:ObservationPregnancyEdd.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1630. Bundle.entry:ObservationPregnancyEdd.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1632. Bundle.entry:ObservationPregnancyEdd.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1634. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1636. Bundle.entry:ObservationPregnancyEdd.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1638. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1640. Bundle.entry:ObservationPregnancyEdd.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1642. Bundle.entry:ObservationPregnancyEdd.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1644. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1646. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1648. Bundle.entry:ObservationPregnancyEdd.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1650. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1652. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1654. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1656. Bundle.entry:ObservationPregnancyEdd.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1658. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1660. Bundle.entry:ObservationPregnancyEdd.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1662. Bundle.entry:ObservationPregnancyEdd.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1664. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1666. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1668. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1670. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1672. Bundle.entry:ObservationPregnancyEdd.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 | ||||||||
| Summary | true | ||||||||
| 1674. Bundle.entry:ObservationPregnancyOutcome | |||||||||
| Slice Name | ObservationPregnancyOutcome | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 1676. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1678. Bundle.entry:ObservationPregnancyOutcome.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1680. Bundle.entry:ObservationPregnancyOutcome.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1682. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1684. Bundle.entry:ObservationPregnancyOutcome.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 1686. Bundle.entry:ObservationPregnancyOutcome.resource | |||||||||
| Definition | Measurements and simple assertions made about a patient, device or other subject. | ||||||||
| Short | Measurements and simple assertions | ||||||||
| Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. | ||||||||
| Control | 1..1 | ||||||||
| Type | Observation(Observation Pregnancy - Outcome (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||||||
| 1688. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1690. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1692. Bundle.entry:ObservationPregnancyOutcome.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1694. Bundle.entry:ObservationPregnancyOutcome.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1696. Bundle.entry:ObservationPregnancyOutcome.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1698. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1700. Bundle.entry:ObservationPregnancyOutcome.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1702. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1704. Bundle.entry:ObservationPregnancyOutcome.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1706. Bundle.entry:ObservationPregnancyOutcome.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1708. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1710. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1712. Bundle.entry:ObservationPregnancyOutcome.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1714. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1716. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1718. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1720. Bundle.entry:ObservationPregnancyOutcome.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1722. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1724. Bundle.entry:ObservationPregnancyOutcome.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1726. Bundle.entry:ObservationPregnancyOutcome.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1728. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1730. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1732. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1734. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1736. Bundle.entry:ObservationPregnancyOutcome.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 | ||||||||
| Summary | true | ||||||||
| 1738. Bundle.entry:ObservationPregnancyStatus | |||||||||
| Slice Name | ObservationPregnancyStatus | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 1740. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1742. Bundle.entry:ObservationPregnancyStatus.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1744. Bundle.entry:ObservationPregnancyStatus.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1746. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1748. Bundle.entry:ObservationPregnancyStatus.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 1750. Bundle.entry:ObservationPregnancyStatus.resource | |||||||||
| Definition | Measurements and simple assertions made about a patient, device or other subject. | ||||||||
| Short | Measurements and simple assertions | ||||||||
| Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. | ||||||||
| Control | 1..1 | ||||||||
| Type | Observation(Observation Pregnancy - Status (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||||||
| 1752. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1754. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1756. Bundle.entry:ObservationPregnancyStatus.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1758. Bundle.entry:ObservationPregnancyStatus.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1760. Bundle.entry:ObservationPregnancyStatus.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1762. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1764. Bundle.entry:ObservationPregnancyStatus.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1766. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1768. Bundle.entry:ObservationPregnancyStatus.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1770. Bundle.entry:ObservationPregnancyStatus.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1772. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1774. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1776. Bundle.entry:ObservationPregnancyStatus.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1778. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1780. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1782. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1784. Bundle.entry:ObservationPregnancyStatus.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1786. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1788. Bundle.entry:ObservationPregnancyStatus.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1790. Bundle.entry:ObservationPregnancyStatus.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1792. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1794. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1796. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1798. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1800. Bundle.entry:ObservationPregnancyStatus.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 | ||||||||
| Summary | true | ||||||||
| 1802. Bundle.entry:ObservationAlcoholUse | |||||||||
| Slice Name | ObservationAlcoholUse | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 1804. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1806. Bundle.entry:ObservationAlcoholUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1808. Bundle.entry:ObservationAlcoholUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1810. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1812. Bundle.entry:ObservationAlcoholUse.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 1814. Bundle.entry:ObservationAlcoholUse.resource | |||||||||
| Definition | Measurements and simple assertions made about a patient, device or other subject. | ||||||||
| Short | Measurements and simple assertions | ||||||||
| Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. | ||||||||
| Control | 1..1 | ||||||||
| Type | Observation(Observation Social History - Alcohol Use (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||||||
| 1816. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1818. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1820. Bundle.entry:ObservationAlcoholUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1822. Bundle.entry:ObservationAlcoholUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1824. Bundle.entry:ObservationAlcoholUse.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1826. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1828. Bundle.entry:ObservationAlcoholUse.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1830. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1832. Bundle.entry:ObservationAlcoholUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1834. Bundle.entry:ObservationAlcoholUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1836. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1838. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1840. Bundle.entry:ObservationAlcoholUse.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1842. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1844. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1846. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1848. Bundle.entry:ObservationAlcoholUse.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1850. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1852. Bundle.entry:ObservationAlcoholUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1854. Bundle.entry:ObservationAlcoholUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1856. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1858. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1860. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1862. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1864. Bundle.entry:ObservationAlcoholUse.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 | ||||||||
| Summary | true | ||||||||
| 1866. Bundle.entry:ObservationTobaccoUse | |||||||||
| Slice Name | ObservationTobaccoUse | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 1868. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1870. Bundle.entry:ObservationTobaccoUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1872. Bundle.entry:ObservationTobaccoUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1874. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1876. Bundle.entry:ObservationTobaccoUse.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 1878. Bundle.entry:ObservationTobaccoUse.resource | |||||||||
| Definition | Measurements and simple assertions made about a patient, device or other subject. | ||||||||
| Short | Measurements and simple assertions | ||||||||
| Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. | ||||||||
| Control | 1..1 | ||||||||
| Type | Observation(Observation Social History - Tobacco Use (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||||||
| 1880. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1882. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1884. Bundle.entry:ObservationTobaccoUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1886. Bundle.entry:ObservationTobaccoUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1888. Bundle.entry:ObservationTobaccoUse.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1890. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1892. Bundle.entry:ObservationTobaccoUse.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1894. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1896. Bundle.entry:ObservationTobaccoUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1898. Bundle.entry:ObservationTobaccoUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1900. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1902. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1904. Bundle.entry:ObservationTobaccoUse.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1906. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1908. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1910. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1912. Bundle.entry:ObservationTobaccoUse.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1914. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1916. Bundle.entry:ObservationTobaccoUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1918. Bundle.entry:ObservationTobaccoUse.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1920. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1922. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1924. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1926. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1928. Bundle.entry:ObservationTobaccoUse.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 | ||||||||
| Summary | true | ||||||||
| 1930. Bundle.entry:ObservationResultsLaboratoryPathology | |||||||||
| Slice Name | ObservationResultsLaboratoryPathology | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 1932. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1934. Bundle.entry:ObservationResultsLaboratoryPathology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1936. Bundle.entry:ObservationResultsLaboratoryPathology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1938. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1940. Bundle.entry:ObservationResultsLaboratoryPathology.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 1942. Bundle.entry:ObservationResultsLaboratoryPathology.resource | |||||||||
| Definition | This observation may represent the result of a simple laboratory or pathology test such as hematocrit, or it may group the set of results produced by a multi-test study or panel such as a complete blood count, a dynamic function test, or a urine specimen study. In the latter case, the observation carries the overall conclusion of the study and references the atomic results of the study as "has-member" child observations | ||||||||
| Short | Laboratory (including Pathology) result for a simple test or for a panel/study | ||||||||
| Comments | Represents either a lab simple observation or the group of observations produced by a laboratory study. | ||||||||
| Control | 1..1 | ||||||||
| Type | Observation(Observation Results - Laboratory/Pathology (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||||||
| 1944. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1946. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1948. Bundle.entry:ObservationResultsLaboratoryPathology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1950. Bundle.entry:ObservationResultsLaboratoryPathology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1952. Bundle.entry:ObservationResultsLaboratoryPathology.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1954. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1956. Bundle.entry:ObservationResultsLaboratoryPathology.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1958. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1960. Bundle.entry:ObservationResultsLaboratoryPathology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1962. Bundle.entry:ObservationResultsLaboratoryPathology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1964. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1966. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1968. Bundle.entry:ObservationResultsLaboratoryPathology.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1970. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1972. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1974. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1976. Bundle.entry:ObservationResultsLaboratoryPathology.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1978. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1980. Bundle.entry:ObservationResultsLaboratoryPathology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 1982. Bundle.entry:ObservationResultsLaboratoryPathology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 1984. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1986. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1988. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1990. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 1992. Bundle.entry:ObservationResultsLaboratoryPathology.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 | ||||||||
| Summary | true | ||||||||
| 1994. Bundle.entry:observationResultsRadiology | |||||||||
| Slice Name | observationResultsRadiology | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 1996. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 1998. Bundle.entry:observationResultsRadiology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2000. Bundle.entry:observationResultsRadiology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2002. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2004. Bundle.entry:observationResultsRadiology.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 2006. Bundle.entry:observationResultsRadiology.resource | |||||||||
| Definition | Measurements and simple assertions made about a patient, device or other subject. | ||||||||
| Short | Measurements and simple assertions | ||||||||
| Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. | ||||||||
| Control | 1..1 | ||||||||
| Type | Observation(Observation Results - Radiology (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||||||
| 2008. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2010. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2012. Bundle.entry:observationResultsRadiology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2014. Bundle.entry:observationResultsRadiology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2016. Bundle.entry:observationResultsRadiology.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2018. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2020. Bundle.entry:observationResultsRadiology.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2022. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2024. Bundle.entry:observationResultsRadiology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2026. Bundle.entry:observationResultsRadiology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2028. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2030. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2032. Bundle.entry:observationResultsRadiology.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2034. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2036. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2038. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2040. Bundle.entry:observationResultsRadiology.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2042. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2044. Bundle.entry:observationResultsRadiology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2046. Bundle.entry:observationResultsRadiology.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2048. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2050. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2052. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2054. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2056. Bundle.entry:observationResultsRadiology.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 | ||||||||
| Summary | true | ||||||||
| 2058. Bundle.entry:ObservationVitalSigns | |||||||||
| Slice Name | ObservationVitalSigns | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 2060. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2062. Bundle.entry:ObservationVitalSigns.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2064. Bundle.entry:ObservationVitalSigns.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2066. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2068. Bundle.entry:ObservationVitalSigns.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 2070. Bundle.entry:ObservationVitalSigns.resource | |||||||||
| Definition | The FHIR Vitals Signs profile sets minimum expectations for the Observation Resource to record, search and fetch the vital signs associated with a patient. | ||||||||
| Short | FHIR Vital Signs Profile | ||||||||
| Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. | ||||||||
| Control | 1..1 | ||||||||
| Type | Observation(Vital Signs Profile) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||||||
| 2072. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2074. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2076. Bundle.entry:ObservationVitalSigns.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2078. Bundle.entry:ObservationVitalSigns.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2080. Bundle.entry:ObservationVitalSigns.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2082. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2084. Bundle.entry:ObservationVitalSigns.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2086. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2088. Bundle.entry:ObservationVitalSigns.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2090. Bundle.entry:ObservationVitalSigns.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2092. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2094. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2096. Bundle.entry:ObservationVitalSigns.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2098. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2100. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2102. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2104. Bundle.entry:ObservationVitalSigns.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2106. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2108. Bundle.entry:ObservationVitalSigns.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2110. Bundle.entry:ObservationVitalSigns.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2112. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2114. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2116. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2118. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2120. Bundle.entry:ObservationVitalSigns.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 | ||||||||
| Summary | true | ||||||||
| 2122. 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 | 0..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 2124. 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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2126. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2128. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2130. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2132. Bundle.entry:Specimen.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 2134. Bundle.entry:Specimen.resource | |||||||||
| Definition | A sample to be used for analysis. | ||||||||
| Short | Sample for analysis | ||||||||
| Control | 1..1 | ||||||||
| Type | Specimen(Specimen (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| 2136. Bundle.entry:Specimen.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2138. Bundle.entry:Specimen.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2140. Bundle.entry:Specimen.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2142. Bundle.entry:Specimen.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2144. Bundle.entry:Specimen.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2146. Bundle.entry:Specimen.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2148. 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 | 0..1 This element is affected by the following invariants: bdl-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2150. 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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2152. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2154. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2156. 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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2158. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2160. 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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2162. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2164. 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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2166. 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..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())) | ||||||||
| 2168. 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..1 This element is affected by the following invariants: bdl-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2170. Bundle.entry:Specimen.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2172. Bundle.entry:Specimen.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2174. Bundle.entry:Specimen.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2176. Bundle.entry:Specimen.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2178. Bundle.entry:Specimen.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2180. Bundle.entry:Specimen.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2182. Bundle.entry:Specimen.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2184. Bundle.entry:Specimen.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 | ||||||||
| Summary | true | ||||||||
| 2186. Bundle.entry:Flag | |||||||||
| Slice Name | Flag | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 2188. Bundle.entry:Flag.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2190. Bundle.entry:Flag.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2192. Bundle.entry:Flag.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2194. Bundle.entry:Flag.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2196. Bundle.entry:Flag.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 2198. Bundle.entry:Flag.resource | |||||||||
| Definition | Prospective warnings of potential issues when providing care to the patient. | ||||||||
| Short | Key information to flag to healthcare providers | ||||||||
| Control | 1..1 | ||||||||
| Type | Flag(Flag - Alert (IPS)) | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | Barriers to Care, Alert, Warning | ||||||||
| 2200. Bundle.entry:Flag.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2202. Bundle.entry:Flag.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2204. Bundle.entry:Flag.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2206. Bundle.entry:Flag.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2208. Bundle.entry:Flag.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2210. Bundle.entry:Flag.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2212. Bundle.entry:Flag.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2214. Bundle.entry:Flag.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2216. Bundle.entry:Flag.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2218. Bundle.entry:Flag.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2220. Bundle.entry:Flag.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2222. Bundle.entry:Flag.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2224. Bundle.entry:Flag.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2226. Bundle.entry:Flag.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2228. Bundle.entry:Flag.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2230. Bundle.entry:Flag.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2232. Bundle.entry:Flag.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2234. Bundle.entry:Flag.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2236. Bundle.entry:Flag.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2238. Bundle.entry:Flag.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2240. Bundle.entry:Flag.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2242. Bundle.entry:Flag.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2244. Bundle.entry:Flag.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2246. Bundle.entry:Flag.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2248. Bundle.entry:Flag.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 | ||||||||
| Summary | true | ||||||||
| 2250. Bundle.entry:ClinicalImpression | |||||||||
| Slice Name | ClinicalImpression | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 2252. Bundle.entry:ClinicalImpression.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2254. Bundle.entry:ClinicalImpression.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2256. Bundle.entry:ClinicalImpression.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2258. Bundle.entry:ClinicalImpression.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2260. Bundle.entry:ClinicalImpression.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 2262. Bundle.entry:ClinicalImpression.resource | |||||||||
| Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | A resource in the bundle | ||||||||
| Control | 1..1 | ||||||||
| Type | ClinicalImpression | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| 2264. Bundle.entry:ClinicalImpression.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2266. Bundle.entry:ClinicalImpression.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2268. Bundle.entry:ClinicalImpression.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2270. Bundle.entry:ClinicalImpression.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2272. Bundle.entry:ClinicalImpression.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2274. Bundle.entry:ClinicalImpression.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2276. Bundle.entry:ClinicalImpression.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2278. Bundle.entry:ClinicalImpression.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2280. Bundle.entry:ClinicalImpression.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2282. Bundle.entry:ClinicalImpression.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2284. Bundle.entry:ClinicalImpression.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2286. Bundle.entry:ClinicalImpression.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2288. Bundle.entry:ClinicalImpression.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2290. Bundle.entry:ClinicalImpression.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2292. Bundle.entry:ClinicalImpression.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2294. Bundle.entry:ClinicalImpression.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2296. Bundle.entry:ClinicalImpression.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2298. Bundle.entry:ClinicalImpression.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2300. Bundle.entry:ClinicalImpression.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2302. Bundle.entry:ClinicalImpression.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2304. Bundle.entry:ClinicalImpression.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2306. Bundle.entry:ClinicalImpression.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2308. Bundle.entry:ClinicalImpression.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2310. Bundle.entry:ClinicalImpression.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2312. Bundle.entry:ClinicalImpression.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 | ||||||||
| Summary | true | ||||||||
| 2314. Bundle.entry:CarePlan | |||||||||
| Slice Name | CarePlan | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 2316. Bundle.entry:CarePlan.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2318. Bundle.entry:CarePlan.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2320. Bundle.entry:CarePlan.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2322. Bundle.entry:CarePlan.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2324. Bundle.entry:CarePlan.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 2326. Bundle.entry:CarePlan.resource | |||||||||
| Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | A resource in the bundle | ||||||||
| Control | 1..1 | ||||||||
| Type | CarePlan | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| 2328. Bundle.entry:CarePlan.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2330. Bundle.entry:CarePlan.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2332. Bundle.entry:CarePlan.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2334. Bundle.entry:CarePlan.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2336. Bundle.entry:CarePlan.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2338. Bundle.entry:CarePlan.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2340. Bundle.entry:CarePlan.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2342. Bundle.entry:CarePlan.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2344. Bundle.entry:CarePlan.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2346. Bundle.entry:CarePlan.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2348. Bundle.entry:CarePlan.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2350. Bundle.entry:CarePlan.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2352. Bundle.entry:CarePlan.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2354. Bundle.entry:CarePlan.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2356. Bundle.entry:CarePlan.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2358. Bundle.entry:CarePlan.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2360. Bundle.entry:CarePlan.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2362. Bundle.entry:CarePlan.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2364. Bundle.entry:CarePlan.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2366. Bundle.entry:CarePlan.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2368. Bundle.entry:CarePlan.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2370. Bundle.entry:CarePlan.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2372. Bundle.entry:CarePlan.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2374. Bundle.entry:CarePlan.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2376. Bundle.entry:CarePlan.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 | ||||||||
| Summary | true | ||||||||
| 2378. Bundle.entry:Consent | |||||||||
| Slice Name | Consent | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 2380. Bundle.entry:Consent.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2382. Bundle.entry:Consent.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2384. Bundle.entry:Consent.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2386. Bundle.entry:Consent.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2388. Bundle.entry:Consent.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 2390. Bundle.entry:Consent.resource | |||||||||
| Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | A resource in the bundle | ||||||||
| Control | 1..1 | ||||||||
| Type | Consent | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| 2392. Bundle.entry:Consent.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2394. Bundle.entry:Consent.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2396. Bundle.entry:Consent.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2398. Bundle.entry:Consent.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2400. Bundle.entry:Consent.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2402. Bundle.entry:Consent.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2404. Bundle.entry:Consent.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2406. Bundle.entry:Consent.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2408. Bundle.entry:Consent.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2410. Bundle.entry:Consent.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2412. Bundle.entry:Consent.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2414. Bundle.entry:Consent.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2416. Bundle.entry:Consent.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2418. Bundle.entry:Consent.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2420. Bundle.entry:Consent.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2422. Bundle.entry:Consent.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2424. Bundle.entry:Consent.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2426. Bundle.entry:Consent.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2428. Bundle.entry:Consent.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2430. Bundle.entry:Consent.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2432. Bundle.entry:Consent.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2434. Bundle.entry:Consent.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2436. Bundle.entry:Consent.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2438. Bundle.entry:Consent.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2440. Bundle.entry:Consent.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 | ||||||||
| Summary | true | ||||||||
| 2442. Bundle.entry:DocumentReference | |||||||||
| Slice Name | DocumentReference | ||||||||
| 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..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | 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.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||||||
| 2444. Bundle.entry:DocumentReference.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2446. Bundle.entry:DocumentReference.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2448. Bundle.entry:DocumentReference.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2450. Bundle.entry:DocumentReference.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2452. Bundle.entry:DocumentReference.fullUrl | |||||||||
| Definition | The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:
| ||||||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||||||
| 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 | ||||||||
| 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()))ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID ( startsWith('http') or startsWith('urn:uuid:') = true) | ||||||||
| 2454. Bundle.entry:DocumentReference.resource | |||||||||
| Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||||||||
| Short | A resource in the bundle | ||||||||
| Control | 1..1 | ||||||||
| Type | DocumentReference | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| 2456. Bundle.entry:DocumentReference.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2458. Bundle.entry:DocumentReference.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2460. Bundle.entry:DocumentReference.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2462. Bundle.entry:DocumentReference.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2464. Bundle.entry:DocumentReference.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 | outcome - 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|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2466. Bundle.entry:DocumentReference.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2468. Bundle.entry:DocumentReference.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-3 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2470. Bundle.entry:DocumentReference.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2472. Bundle.entry:DocumentReference.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2474. Bundle.entry:DocumentReference.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2476. Bundle.entry:DocumentReference.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 | ||||||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2478. Bundle.entry:DocumentReference.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2480. Bundle.entry:DocumentReference.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 currency | ||||||||
| 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 | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2482. Bundle.entry:DocumentReference.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2484. Bundle.entry:DocumentReference.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2486. Bundle.entry:DocumentReference.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2488. Bundle.entry:DocumentReference.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-4 | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2490. Bundle.entry:DocumentReference.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 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 2492. Bundle.entry:DocumentReference.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| 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()) | ||||||||
| 2494. Bundle.entry:DocumentReference.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| 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()) | ||||||||
| 2496. Bundle.entry:DocumentReference.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2498. Bundle.entry:DocumentReference.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2500. Bundle.entry:DocumentReference.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2502. Bundle.entry:DocumentReference.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 | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 2504. Bundle.entry:DocumentReference.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 | ||||||||
| Summary | true | ||||||||
| 2506. Bundle.signature | |||||||||
| Definition | Digital Signature - base64 encoded. XML-DSig or a JWT. | ||||||||
| 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..1 | ||||||||
| Type | Signature | ||||||||
| Is Modifier | 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())) | ||||||||