MedNet interface implementation guide
0.16.0 - CI Build
Publication Build: This will be filled in by the publication tooling
Active as of 2021-01-17 |
Definitions for the mni-patientOverview-bundle resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Bundle | |
Definition | A container for a collection of resources. |
Short | MedNet Interface (MNI) - PatientOverview BundleContains a collection of resources |
Control | 10..1* |
Is Modifier | false |
Summary | false |
Invariants | bdl-1: total only when a search or history (total.empty() or (type = 'searchset') or (type = 'history') )bdl-2: entry.search only when a search ( 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.id | |
Definition | The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-', '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Short | The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)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 | idstring |
Is Modifier | false |
Must Support | true |
Summary | true |
4. 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())) |
6. Bundle.identifier | |
Definition | A persistent identifier for the bundle that won't change as a bundle is copied from server to server. |
Short | A unique identifier of the Bundle in UUID format. Could represent a transaction numberPersistent 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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
8. 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())) |
10. 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 |
Must Support | true |
Summary | true |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Fixed Value | urn:ietf:rfc:3986 |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
12. 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 | A UUID for the Bundle. It can be the same as Bundle/id if it is also an UUID (prefixed with urn:uuid)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 |
Must Support | true |
Summary | true |
Example | <br/><b>General</b>:123456 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
14. Bundle.type | |
Definition | Indicates the purpose of this bundle - how it is intended to be used. |
Short | Fixed value : 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 |
Must Support | true |
Summary | true |
Fixed Value | document |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
16. Bundle.timestamp | |
Definition | An instant in time in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (e.g. 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time SHALL specified at least to the second and SHALL include a time zone. Note: This is intended for when precisely observed times are required (typically system logs etc.), and not human-reported times - for those, use date or dateTime (which can be as precise as instant, but is not required to be). instant is a more constrained dateTime 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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. Bundle.entry | |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | First Composition must be a mni-patientOverview-compositionEntry in the bundle - will have a resource or information |
Control | 10..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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: |
20. 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()) |
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 | CompositionEntry in the bundle - will have a resource or information |
Control | 10..1* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
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 | MedNet Interface (MNI) - PatientOverview 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(MedNet Interface (MNI) - PatientOverview Composition) |
Is Modifier | false |
Must Support | true |
Summary | false |
30. 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 | all the Encounter objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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: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()) |
34. 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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
36. Bundle.entry:Encounter.resource | |
Definition | An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
Short | MedNet Interface (MNI) - EncounterA resource in the bundle |
Control | 10..1 |
Type | EncounterResource(MedNet Interface (MNI) - Encounter) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | Visit |
38. Bundle.entry:ServiceRequest | |
Slice Name | ServiceRequest |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | all the ServiceRequest objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
40. Bundle.entry:ServiceRequest.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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.entry:ServiceRequest.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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
44. Bundle.entry:ServiceRequest.resource | |
Definition | A record of a request for service such as diagnostic investigations, treatments, or operations to be performed. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
Short | MedNet Interface (MNI) - ServiceRequestA resource in the bundle |
Control | 10..1 |
Type | ServiceRequestResource(MedNet Interface (MNI) - ServiceRequest) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | diagnostic request, referral, referral request, transfer of care request |
46. 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 | all the Patient objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
48. 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()) |
50. 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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
52. Bundle.entry:Patient.resource | |
Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
Short | MedNet Interface (MNI) - PatientA resource in the bundle |
Control | 10..1 |
Type | PatientResource(MedNet Interface (MNI) - Patient) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | SubjectOfCare Client Resident |
54. 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 | all the Practitioner objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
56. 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()) |
58. 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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
60. Bundle.entry:Practitioner.resource | |
Definition | A person who is directly or indirectly involved in the provisioning of healthcare. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
Short | A person with a formal responsibility in the provisioning of healthcare or related servicesA resource in the bundle |
Control | 10..1 |
Type | PractitionerResource(Practitioner) |
Is Modifier | false |
Must Support | true |
Summary | false |
62. 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 | all the Organization objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
64. 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()) |
66. 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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
68. 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 | MedNet Interface (MNI) - OrganizationA resource in the bundle |
Control | 10..1 |
Type | OrganizationResource(MedNet Interface (MNI) - Organization) |
Is Modifier | false |
Must Support | true |
Summary | false |
70. 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 | all the PractitionerRole objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
72. 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()) |
74. 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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:8675b428-fc7b-4b47-b1f4-ea20cbeaa2a5 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
76. 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 | MedNet Interface (MNI) - PractitionerRoleA resource in the bundle |
Control | 10..1 |
Type | PractitionerRoleResource(MedNet Interface (MNI) - PractitionerRole) |
Is Modifier | false |
Must Support | true |
Summary | false |
78. 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 | all the RelatedPerson objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
80. 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()) |
82. 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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
84. 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 | MedNet Interface (MNI) - RelatedPersonA resource in the bundle |
Control | 10..1 |
Type | RelatedPersonResource(MedNet Interface (MNI) - RelatedPerson) |
Is Modifier | false |
Must Support | true |
Summary | false |
86. 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 | all the Device objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
88. 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()) |
90. 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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
92. 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 | MedNet Interface (MNI) - DeviceA resource in the bundle |
Control | 10..1 |
Type | DeviceResource(MedNet Interface (MNI) - Device) |
Is Modifier | false |
Must Support | true |
Summary | false |
94. Bundle.entry:Coverage | |
Slice Name | Coverage |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | all the Coverage objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
96. Bundle.entry:Coverage.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()) |
98. Bundle.entry:Coverage.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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
100. Bundle.entry:Coverage.resource | |
Definition | Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
Short | MedNet Interface (MNI) - CoverageA resource in the bundle |
Comments | The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers. |
Control | 10..1 |
Type | CoverageResource(MedNet Interface (MNI) - Coverage) |
Is Modifier | false |
Must Support | true |
Summary | false |
102. Bundle.entry:Contract | |
Slice Name | Contract |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | all the Contract objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
104. Bundle.entry:Contract.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()) |
106. Bundle.entry:Contract.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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
108. Bundle.entry:Contract.resource | |
Definition | Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
Short | MedNet Interface (MNI) - ContractA resource in the bundle |
Control | 10..1 |
Type | ContractResource(MedNet Interface (MNI) - Contract) |
Is Modifier | false |
Must Support | true |
Summary | false |
110. Bundle.entry:BodyWeight | |
Slice Name | BodyWeight |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | all the BodyWeight objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
112. Bundle.entry:BodyWeight.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()) |
114. Bundle.entry:BodyWeight.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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
116. Bundle.entry:BodyWeight.resource | |
Definition | This profile defines how to represent body weight observations in FHIR using a standard LOINC code and UCUM units of measure. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
Short | MedNet Interface (MNI) - Body WeightA 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(MedNet Interface (MNI) - Body Weight) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | Vital Signs, Measurement, Results, Tests |
118. Bundle.entry:BodyHeight | |
Slice Name | BodyHeight |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | all the BodyHeight objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
120. Bundle.entry:BodyHeight.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()) |
122. Bundle.entry:BodyHeight.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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:194bded3-96d7-46e3-ad73-98d38100d702 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
124. Bundle.entry:BodyHeight.resource | |
Definition | This profile defines how to represent Body Height observations in FHIR using a standard LOINC code and UCUM units of measure. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
Short | MedNet Interface (MNI) - Body Height 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(MedNet Interface (MNI) - Body Height) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | Vital Signs, Measurement, Results, Tests |
126. Bundle.entry:BodyMassIndex | |
Slice Name | BodyMassIndex |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | all the BodyMassIndex objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
128. Bundle.entry:BodyMassIndex.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()) |
130. Bundle.entry:BodyMassIndex.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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:0359a120-223b-4169-83f4-1325a53f25de In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
132. Bundle.entry:BodyMassIndex.resource | |
Definition | This profile defines how to represent Body Mass Index (BMI) observations in FHIR using a standard LOINC code and UCUM units of measure. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
Short | MedNet Interface (MNI) - Body Mass IndexA 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(MedNet Interface (MNI) - Body Mass Index) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | Vital Signs, Measurement, Results, Tests |
134. Bundle.entry:BloodPressure | |
Slice Name | BloodPressure |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | all the BloodPressure objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
136. Bundle.entry:BloodPressure.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()) |
138. Bundle.entry:BloodPressure.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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:566f7907-642a-4e97-a2ec-9e98b2e7b48d In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
140. Bundle.entry:BloodPressure.resource | |
Definition | This profile defines how to represent Blood Pressure observations in FHIR using a standard LOINC code and UCUM units of measure. This is a grouping structure. It has no value in Observation.valueQuantity but contains at least one component (systolic and/or diastolic). The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
Short | MedNet Interface (MNI) - Blood PressureA 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(MedNet Interface (MNI) - Blood Pressure) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | Vital Signs, Measurement, Results, Tests |
142. Bundle.entry:BloodGroup | |
Slice Name | BloodGroup |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | all the BloodGroup objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
144. Bundle.entry:BloodGroup.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()) |
146. Bundle.entry:BloodGroup.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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:f0f2f934-046a-4744-90c4-27133cd7a0fe In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
148. Bundle.entry:BloodGroup.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 | MedNet Interface (MNI) - Blood GroupA 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(MedNet Interface (MNI) - Blood Group) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | Vital Signs, Measurement, Results, Tests |
150. Bundle.entry:RiskFactor | |
Slice Name | RiskFactor |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | all the RiskFactor objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
152. Bundle.entry:RiskFactor.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()) |
154. Bundle.entry:RiskFactor.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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:3906daac-6063-43cf-85c4-8608f14f6d39 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
156. Bundle.entry:RiskFactor.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 | MedNet Interface (MNI) - Risk FactorA 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(MedNet Interface (MNI) - Risk Factor) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | Vital Signs, Measurement, Results, Tests |
158. Bundle.entry:EstimatedDateOfConception | |
Slice Name | EstimatedDateOfConception |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | all the EstimatedDateOfConception objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
160. Bundle.entry:EstimatedDateOfConception.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()) |
162. Bundle.entry:EstimatedDateOfConception.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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:7c3334b0-4d26-4cc2-a970-27b6c2fbe4e9 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
164. Bundle.entry:EstimatedDateOfConception.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 | MedNet Interface (MNI) - Estimated date of conceptionA 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(MedNet Interface (MNI) - Estimated date of conception) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | Vital Signs, Measurement, Results, Tests |
166. Bundle.entry:EstimatedDateOfDelivery | |
Slice Name | EstimatedDateOfDelivery |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | all the EstimatedDateOfDelivery objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
168. Bundle.entry:EstimatedDateOfDelivery.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()) |
170. Bundle.entry:EstimatedDateOfDelivery.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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:923b4572-a6c9-415b-8ebe-0038accfe8f3 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
172. Bundle.entry:EstimatedDateOfDelivery.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 | MedNet Interface (MNI) - Estimated date of deliveryA 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(MedNet Interface (MNI) - Estimated date of delivery) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | Vital Signs, Measurement, Results, Tests |
174. Bundle.entry:DateOfLastMenstruation | |
Slice Name | DateOfLastMenstruation |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | all the DateOfLastMenstruation objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
176. Bundle.entry:DateOfLastMenstruation.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()) |
178. Bundle.entry:DateOfLastMenstruation.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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:2efc9728-d0dd-4214-8bdc-77a428ae421b In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
180. Bundle.entry:DateOfLastMenstruation.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 | MedNet Interface (MNI) - First day of last menstruationA 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(MedNet Interface (MNI) - First day of last menstruation) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | Vital Signs, Measurement, Results, Tests |
182. Bundle.entry:TimeOfGestation | |
Slice Name | TimeOfGestation |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | all the TimeOfGestation objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
184. Bundle.entry:TimeOfGestation.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()) |
186. Bundle.entry:TimeOfGestation.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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:b14e0f82-d131-4280-a736-c4dfae9d4a45 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
188. Bundle.entry:TimeOfGestation.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 | MedNet Interface (MNI) - Time of gestationA 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(MedNet Interface (MNI) - Time of gestation) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | Vital Signs, Measurement, Results, Tests |
190. Bundle.entry:Laboratory | |
Slice Name | Laboratory |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | all the Laboratory objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
192. Bundle.entry:Laboratory.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()) |
194. Bundle.entry:Laboratory.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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:3d365d98-d069-4194-bf6d-bfbdfd91a703 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
196. Bundle.entry:Laboratory.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 | MedNet Interface (MNI) - Laboratory ObservationA 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(MedNet Interface (MNI) - Laboratory Observation) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | Vital Signs, Measurement, Results, Tests |
198. Bundle.entry:Annotation | |
Slice Name | Annotation |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | all the Annotation objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
200. Bundle.entry:Annotation.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()) |
202. Bundle.entry:Annotation.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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:3a29da06-4994-4c84-8cc9-3b1210c934ed In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
204. Bundle.entry:Annotation.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 | MedNet Interface (MNI) - Annotation ObservationA 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(MedNet Interface (MNI) - Annotation Observation) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | Vital Signs, Measurement, Results, Tests |
206. 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 | all the DocumentReference objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
208. 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()) |
210. 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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
212. Bundle.entry:DocumentReference.resource | |
Definition | A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
Short | MedNet Interface (MNI) - DocumentReferenceA resource in the bundle |
Comments | Usually, this is used for documents other than those defined by FHIR. |
Control | 10..1 |
Type | DocumentReferenceResource(MedNet Interface (MNI) - DocumentReference) |
Is Modifier | false |
Must Support | true |
Summary | false |
214. 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 | all the Procedure objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
216. 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()) |
218. 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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
220. 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 | MedNet Interface (MNI) - ProcedureA resource in the bundle |
Control | 10..1 |
Type | ProcedureResource(MedNet Interface (MNI) - Procedure) |
Is Modifier | false |
Must Support | true |
Summary | false |
222. 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 | all the Condition objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
224. 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()) |
226. 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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
228. 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 | MedNet Interface (MNI) - ConditionA resource in the bundle |
Control | 10..1 |
Type | ConditionResource(MedNet Interface (MNI) - Condition) |
Is Modifier | false |
Must Support | true |
Summary | false |
230. Bundle.entry:FamilyMemberHistory | |
Slice Name | FamilyMemberHistory |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Short | all the FamilyMemberHistory objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
232. Bundle.entry:FamilyMemberHistory.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()) |
234. Bundle.entry:FamilyMemberHistory.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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
236. Bundle.entry:FamilyMemberHistory.resource | |
Definition | Significant health conditions for a person related to the patient relevant in the context of care for the patient. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
Short | MedNet Interface (MNI) - Family Member HistoryA resource in the bundle |
Control | 10..1 |
Type | FamilyMemberHistoryResource(MedNet Interface (MNI) - Family Member History) |
Is Modifier | false |
Must Support | true |
Summary | false |
238. 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 | all the AllergyIntolerance objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
240. 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()) |
242. 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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
244. 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 | MedNet Interface (MNI) - Allergy IntoleranceA 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(MedNet Interface (MNI) - Allergy Intolerance) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | Allergy, Intolerance, Adverse Reaction |
246. 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 | all the MedicationStatement objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
248. 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()) |
250. 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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
252. 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 | MedNet Interface (MNI) - Medication StatementA 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(MedNet Interface (MNI) - Medication Statement) |
Is Modifier | false |
Must Support | true |
Summary | false |
254. 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 | all the Medication objects includedEntry in the bundle - will have a resource or information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) |
256. 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()) |
258. 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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle.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 |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
260. 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 | MedNet Interface (MNI) - MedicationA resource in the bundle |
Control | 10..1 |
Type | MedicationResource(MedNet Interface (MNI) - Medication) |
Is Modifier | false |
Must Support | true |
Summary | false |
Guidance on how to interpret the contents of this table can be found here
0. Bundle | |
Short | MedNet Interface (MNI) - PatientOverview Bundle |
Control | 1..1 |
2. Bundle.id | |
Definition | The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-', '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) |
Short | The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) |
Must Support | true |
4. Bundle.identifier | |
Short | A unique identifier of the Bundle in UUID format. Could represent a transaction number |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..1 |
Must Support | true |
6. Bundle.identifier.system | |
Control | 1..1 |
Must Support | true |
Fixed Value | urn:ietf:rfc:3986 |
8. Bundle.identifier.value | |
Short | A UUID for the Bundle. It can be the same as Bundle/id if it is also an UUID (prefixed with urn:uuid) |
Control | 1..1 |
Must Support | true |
10. Bundle.type | |
Short | Fixed value : document |
Must Support | true |
Fixed Value | document |
12. Bundle.timestamp | |
Definition | An instant in time in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (e.g. 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time SHALL specified at least to the second and SHALL include a time zone. Note: This is intended for when precisely observed times are required (typically system logs etc.), and not human-reported times - for those, use date or dateTime (which can be as precise as instant, but is not required to be). instant is a more constrained dateTime |
Control | 1..? |
Must Support | true |
14. Bundle.entry | |
Short | First Composition must be a mni-patientOverview-composition |
Control | 1..? |
Must Support | true |
Slicing | This element introduces a set of slices on Bundle.entry . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
16. Bundle.entry:Composition | |
Slice Name | Composition |
Short | Composition |
Control | 1..1 |
Must Support | true |
18. Bundle.entry:Composition.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
20. Bundle.entry:Composition.resource | |
Control | 1..1 |
Type | Composition(MedNet Interface (MNI) - PatientOverview Composition) |
Must Support | true |
22. Bundle.entry:Encounter | |
Slice Name | Encounter |
Short | all the Encounter objects included |
Control | 0..* |
Must Support | true |
24. Bundle.entry:Encounter.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
26. Bundle.entry:Encounter.resource | |
Control | 1..1 |
Type | Encounter(MedNet Interface (MNI) - Encounter) |
Must Support | true |
28. Bundle.entry:ServiceRequest | |
Slice Name | ServiceRequest |
Short | all the ServiceRequest objects included |
Control | 0..* |
Must Support | true |
30. Bundle.entry:ServiceRequest.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
32. Bundle.entry:ServiceRequest.resource | |
Control | 1..1 |
Type | ServiceRequest(MedNet Interface (MNI) - ServiceRequest) |
Must Support | true |
34. Bundle.entry:Patient | |
Slice Name | Patient |
Short | all the Patient objects included |
Control | 0..* |
Must Support | true |
36. Bundle.entry:Patient.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
38. Bundle.entry:Patient.resource | |
Control | 1..1 |
Type | Patient(MedNet Interface (MNI) - Patient) |
Must Support | true |
40. Bundle.entry:Practitioner | |
Slice Name | Practitioner |
Short | all the Practitioner objects included |
Control | 0..* |
Must Support | true |
42. Bundle.entry:Practitioner.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
44. Bundle.entry:Practitioner.resource | |
Control | 1..1 |
Type | Practitioner(Practitioner) |
Must Support | true |
46. Bundle.entry:Organization | |
Slice Name | Organization |
Short | all the Organization objects included |
Control | 0..* |
Must Support | true |
48. Bundle.entry:Organization.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
50. Bundle.entry:Organization.resource | |
Control | 1..1 |
Type | Organization(MedNet Interface (MNI) - Organization) |
Must Support | true |
52. Bundle.entry:PractitionerRole | |
Slice Name | PractitionerRole |
Short | all the PractitionerRole objects included |
Control | 0..* |
Must Support | true |
54. Bundle.entry:PractitionerRole.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:8675b428-fc7b-4b47-b1f4-ea20cbeaa2a5 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
56. Bundle.entry:PractitionerRole.resource | |
Control | 1..1 |
Type | PractitionerRole(MedNet Interface (MNI) - PractitionerRole) |
Must Support | true |
58. Bundle.entry:RelatedPerson | |
Slice Name | RelatedPerson |
Short | all the RelatedPerson objects included |
Control | 0..* |
Must Support | true |
60. Bundle.entry:RelatedPerson.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
62. Bundle.entry:RelatedPerson.resource | |
Control | 1..1 |
Type | RelatedPerson(MedNet Interface (MNI) - RelatedPerson) |
Must Support | true |
64. Bundle.entry:Device | |
Slice Name | Device |
Short | all the Device objects included |
Control | 0..* |
Must Support | true |
66. Bundle.entry:Device.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
68. Bundle.entry:Device.resource | |
Control | 1..1 |
Type | Device(MedNet Interface (MNI) - Device) |
Must Support | true |
70. Bundle.entry:Coverage | |
Slice Name | Coverage |
Short | all the Coverage objects included |
Control | 0..* |
Must Support | true |
72. Bundle.entry:Coverage.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
74. Bundle.entry:Coverage.resource | |
Control | 1..1 |
Type | Coverage(MedNet Interface (MNI) - Coverage) |
Must Support | true |
76. Bundle.entry:Contract | |
Slice Name | Contract |
Short | all the Contract objects included |
Control | 0..* |
Must Support | true |
78. Bundle.entry:Contract.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
80. Bundle.entry:Contract.resource | |
Control | 1..1 |
Type | Contract(MedNet Interface (MNI) - Contract) |
Must Support | true |
82. Bundle.entry:BodyWeight | |
Slice Name | BodyWeight |
Short | all the BodyWeight objects included |
Control | 0..* |
Must Support | true |
84. Bundle.entry:BodyWeight.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
86. Bundle.entry:BodyWeight.resource | |
Control | 1..1 |
Type | Observation(MedNet Interface (MNI) - Body Weight) |
Must Support | true |
88. Bundle.entry:BodyHeight | |
Slice Name | BodyHeight |
Short | all the BodyHeight objects included |
Control | 0..* |
Must Support | true |
90. Bundle.entry:BodyHeight.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:194bded3-96d7-46e3-ad73-98d38100d702 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
92. Bundle.entry:BodyHeight.resource | |
Control | 1..1 |
Type | Observation(MedNet Interface (MNI) - Body Height) |
Must Support | true |
94. Bundle.entry:BodyMassIndex | |
Slice Name | BodyMassIndex |
Short | all the BodyMassIndex objects included |
Control | 0..* |
Must Support | true |
96. Bundle.entry:BodyMassIndex.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:0359a120-223b-4169-83f4-1325a53f25de In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
98. Bundle.entry:BodyMassIndex.resource | |
Control | 1..1 |
Type | Observation(MedNet Interface (MNI) - Body Mass Index) |
Must Support | true |
100. Bundle.entry:BloodPressure | |
Slice Name | BloodPressure |
Short | all the BloodPressure objects included |
Control | 0..* |
Must Support | true |
102. Bundle.entry:BloodPressure.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:566f7907-642a-4e97-a2ec-9e98b2e7b48d In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
104. Bundle.entry:BloodPressure.resource | |
Control | 1..1 |
Type | Observation(MedNet Interface (MNI) - Blood Pressure) |
Must Support | true |
106. Bundle.entry:BloodGroup | |
Slice Name | BloodGroup |
Short | all the BloodGroup objects included |
Control | 0..* |
Must Support | true |
108. Bundle.entry:BloodGroup.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:f0f2f934-046a-4744-90c4-27133cd7a0fe In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
110. Bundle.entry:BloodGroup.resource | |
Control | 1..1 |
Type | Observation(MedNet Interface (MNI) - Blood Group) |
Must Support | true |
112. Bundle.entry:RiskFactor | |
Slice Name | RiskFactor |
Short | all the RiskFactor objects included |
Control | 0..* |
Must Support | true |
114. Bundle.entry:RiskFactor.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:3906daac-6063-43cf-85c4-8608f14f6d39 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
116. Bundle.entry:RiskFactor.resource | |
Control | 1..1 |
Type | Observation(MedNet Interface (MNI) - Risk Factor) |
Must Support | true |
118. Bundle.entry:EstimatedDateOfConception | |
Slice Name | EstimatedDateOfConception |
Short | all the EstimatedDateOfConception objects included |
Control | 0..* |
Must Support | true |
120. Bundle.entry:EstimatedDateOfConception.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:7c3334b0-4d26-4cc2-a970-27b6c2fbe4e9 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
122. Bundle.entry:EstimatedDateOfConception.resource | |
Control | 1..1 |
Type | Observation(MedNet Interface (MNI) - Estimated date of conception) |
Must Support | true |
124. Bundle.entry:EstimatedDateOfDelivery | |
Slice Name | EstimatedDateOfDelivery |
Short | all the EstimatedDateOfDelivery objects included |
Control | 0..* |
Must Support | true |
126. Bundle.entry:EstimatedDateOfDelivery.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:923b4572-a6c9-415b-8ebe-0038accfe8f3 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
128. Bundle.entry:EstimatedDateOfDelivery.resource | |
Control | 1..1 |
Type | Observation(MedNet Interface (MNI) - Estimated date of delivery) |
Must Support | true |
130. Bundle.entry:DateOfLastMenstruation | |
Slice Name | DateOfLastMenstruation |
Short | all the DateOfLastMenstruation objects included |
Control | 0..* |
Must Support | true |
132. Bundle.entry:DateOfLastMenstruation.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:2efc9728-d0dd-4214-8bdc-77a428ae421b In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
134. Bundle.entry:DateOfLastMenstruation.resource | |
Control | 1..1 |
Type | Observation(MedNet Interface (MNI) - First day of last menstruation) |
Must Support | true |
136. Bundle.entry:TimeOfGestation | |
Slice Name | TimeOfGestation |
Short | all the TimeOfGestation objects included |
Control | 0..* |
Must Support | true |
138. Bundle.entry:TimeOfGestation.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:b14e0f82-d131-4280-a736-c4dfae9d4a45 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
140. Bundle.entry:TimeOfGestation.resource | |
Control | 1..1 |
Type | Observation(MedNet Interface (MNI) - Time of gestation) |
Must Support | true |
142. Bundle.entry:Laboratory | |
Slice Name | Laboratory |
Short | all the Laboratory objects included |
Control | 0..* |
Must Support | true |
144. Bundle.entry:Laboratory.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:3d365d98-d069-4194-bf6d-bfbdfd91a703 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
146. Bundle.entry:Laboratory.resource | |
Control | 1..1 |
Type | Observation(MedNet Interface (MNI) - Laboratory Observation) |
Must Support | true |
148. Bundle.entry:Annotation | |
Slice Name | Annotation |
Short | all the Annotation objects included |
Control | 0..* |
Must Support | true |
150. Bundle.entry:Annotation.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:3a29da06-4994-4c84-8cc9-3b1210c934ed In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
152. Bundle.entry:Annotation.resource | |
Control | 1..1 |
Type | Observation(MedNet Interface (MNI) - Annotation Observation) |
Must Support | true |
154. Bundle.entry:DocumentReference | |
Slice Name | DocumentReference |
Short | all the DocumentReference objects included |
Control | 0..* |
Must Support | true |
156. Bundle.entry:DocumentReference.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
158. Bundle.entry:DocumentReference.resource | |
Control | 1..1 |
Type | DocumentReference(MedNet Interface (MNI) - DocumentReference) |
Must Support | true |
160. Bundle.entry:Procedure | |
Slice Name | Procedure |
Short | all the Procedure objects included |
Control | 0..* |
Must Support | true |
162. Bundle.entry:Procedure.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
164. Bundle.entry:Procedure.resource | |
Control | 1..1 |
Type | Procedure(MedNet Interface (MNI) - Procedure) |
Must Support | true |
166. Bundle.entry:Condition | |
Slice Name | Condition |
Short | all the Condition objects included |
Control | 0..* |
Must Support | true |
168. Bundle.entry:Condition.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
170. Bundle.entry:Condition.resource | |
Control | 1..1 |
Type | Condition(MedNet Interface (MNI) - Condition) |
Must Support | true |
172. Bundle.entry:FamilyMemberHistory | |
Slice Name | FamilyMemberHistory |
Short | all the FamilyMemberHistory objects included |
Control | 0..* |
Must Support | true |
174. Bundle.entry:FamilyMemberHistory.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
176. Bundle.entry:FamilyMemberHistory.resource | |
Control | 1..1 |
Type | FamilyMemberHistory(MedNet Interface (MNI) - Family Member History) |
Must Support | true |
178. Bundle.entry:AllergyIntolerance | |
Slice Name | AllergyIntolerance |
Short | all the AllergyIntolerance objects included |
Control | 0..* |
Must Support | true |
180. Bundle.entry:AllergyIntolerance.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
182. Bundle.entry:AllergyIntolerance.resource | |
Control | 1..1 |
Type | AllergyIntolerance(MedNet Interface (MNI) - Allergy Intolerance) |
Must Support | true |
184. Bundle.entry:MedicationStatement | |
Slice Name | MedicationStatement |
Short | all the MedicationStatement objects included |
Control | 0..* |
Must Support | true |
186. Bundle.entry:MedicationStatement.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
188. Bundle.entry:MedicationStatement.resource | |
Control | 1..1 |
Type | MedicationStatement(MedNet Interface (MNI) - Medication Statement) |
Must Support | true |
190. Bundle.entry:Medication | |
Slice Name | Medication |
Short | all the Medication objects included |
Control | 0..* |
Must Support | true |
192. Bundle.entry:Medication.fullUrl | |
Short | URI for the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. |
Control | 1..1 |
Must Support | true |
194. Bundle.entry:Medication.resource | |
Control | 1..1 |
Type | Medication(MedNet Interface (MNI) - Medication) |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
0. Bundle | |||||
Definition | A container for a collection of resources. | ||||
Short | MedNet Interface (MNI) - PatientOverview Bundle | ||||
Control | 1..1 | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | bdl-1: total only when a search or history (total.empty() or (type = 'searchset') or (type = 'history') )bdl-2: entry.search only when a search ( 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 id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-', '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) | ||||
Short | The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) | ||||
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 | ||||
Must Support | true | ||||
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 )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 | A unique identifier of the Bundle in UUID format. Could represent a transaction number | ||||
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 | ||||
Must Support | true | ||||
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 )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 | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Fixed Value | urn:ietf:rfc:3986 | ||||
Example | <br/><b>General</b>: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 | A UUID for the Bundle. It can be the same as Bundle/id if it is also an UUID (prefixed with urn:uuid) | ||||
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 | ||||
Must Support | true | ||||
Summary | true | ||||
Example | <br/><b>General</b>: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 | Fixed value : 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 | ||||
Must Support | true | ||||
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 | An instant in time in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (e.g. 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time SHALL specified at least to the second and SHALL include a time zone. Note: This is intended for when precisely observed times are required (typically system logs etc.), and not human-reported times - for those, use date or dateTime (which can be as precise as instant, but is not required to be). instant is a more constrained dateTime | ||||
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 | ||||
Must Support | true | ||||
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 | First Composition must be a mni-patientOverview-composition | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Must Support | true | ||||
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 | 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()) ) | ||||
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 | Composition | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Must Support | true | ||||
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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. | ||||
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 | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
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 | MedNet Interface (MNI) - PatientOverview 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(MedNet Interface (MNI) - PatientOverview Composition) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
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: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 | all the Encounter objects included | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Must Support | true | ||||
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: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 | ||||
178. 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() ) | ||||
180. 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() ) | ||||
182. 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()) ) | ||||
184. 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 the resource. Made from <resource type>/<resource id> This could also be an url from type https://server/<resource type>/<resource id> or an UUID like urn:uuid:148d342c-5052-4b9e-8370-2923af30e867 In this case, this should also be used as reference value in all the bundle. | ||||
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 | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
186. Bundle.entry:Encounter.resource | |||||
Definition | An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. | ||||
Short | MedNet Interface (MNI) - Encounter | ||||
Control | 1..1 | ||||
Type | Encounter(MedNet Interface (MNI) - Encounter) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Alternate Names | Visit | ||||
188. 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()) ) | ||||
190. 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 | ||||
192. 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() ) | ||||
194. 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() ) | ||||
196. 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()) ) | ||||
198. 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()) ) | ||||
200. 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()) ) | ||||
202. 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 | ||||
204. 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() ) | ||||
206. 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() ) | ||||
208. 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, o |