【2026.8.31リリース予定の公開準備版】電子カルテ情報共有サービス2文書5情報+患者サマリー FHIR実装ガイド JP-CLINS(CLinical Information Sharing ImplementationGuide) v1.13.0-preR1
1.13.0-preR1 - update
Japan
【2026.8.31リリース予定の公開準備版】電子カルテ情報共有サービス2文書5情報+患者サマリー FHIR実装ガイド JP-CLINS(CLinical Information Sharing ImplementationGuide) v1.13.0-preR1 - Local Development build (v1.13.0-preR1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2024-09-14 |
Definitions for the JP-Bundle-eDischargeSummary resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Bundle | |
| Definition | 退院時サマリーのための文書 Bundleリソース A container for a collection of resources. |
| Short | 退院時サマリーのための文書 BundleリソースContains a collection of resources |
| Control | 0..* |
| 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))valid-system-bundleIdenfifier: R02151:Bundle.identifier.sysyemは、http://jpfhir.jp/fhir/clins/bundle-identifier ( identifier.where(system='http://jpfhir.jp/fhir/clins/bundle-identifier').exists())valid-value-bundleIdenfifier: R2152:Bundle.identifier.value は、医療機関番号10桁^西暦4件^36文字以内の半角文字列(英字、数字、ハイフン記号のみ可)であること。'^[0-4][0-9][1-3][0-9]{7}[\^]20[2-3][0-9][\^][A-Za-z0-9\-]{1,36}$' ( (identifier.where(system = 'http://jpfhir.jp/fhir/clins/bundle-identifier').count()=1 and identifier.where(system = 'http://jpfhir.jp/fhir/clins/bundle-identifier').value.matches('^[0-4][0-9][1-3][0-9]{7}[\\^]20[2-3][0-9][\\^][A-Za-z0-9\\-]{1,36}$')))validEntryProfile-MedicationRequest: Bundle-entry-MedicationRequest: Bundleのentryとして含まれるMedicationRequestは、プロファイルJP_MedicationRequest_eCSのいずれかのバージョンに準拠していなければならない。 ( (entry.resource.ofType(MedicationRequest).exists().not()) or ((entry.resource.ofType(MedicationRequest).meta.profile.where(($this.indexOf('|')>0 and ($this.substring(0,$this.indexOf('|'))!='http://jpfhir.jp/fhir/eCS/StructureDefinition/JP_MedicationRequest_eCS'))).exists()).not() ) and ((entry.resource.ofType(MedicationRequest).meta.profile.where(($this.indexOf('|')<=0 and ($this!='http://jpfhir.jp/fhir/eCS/StructureDefinition/JP_MedicationRequest_eCS'))).exists()).not() ))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.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 | 10..1 |
| Type | Meta |
| 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()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. Bundle.meta.lastUpdated | |
| Definition | When the resource last changed - e.g. when the version changed. |
| Short | When the resource version last changed |
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
| 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()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. Bundle.meta.profile | |
| Definition | 準拠しているプロファイルとして次のURLとバージョンを指定する。バージョン指定を省略した場合には、データ受信時点の最新バージョンとみなされる。http://jpfhir.jp/fhir/clins/StructureDefinition/JP_Bundle_eDischargeSummary|x.y.z A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
| Short | 準拠しているプロファイルとして次のURLとバージョンを指定する。バージョン指定を省略した場合には、データ受信時点の最新バージョンとみなされる。http://jpfhir.jp/fhir/clins/StructureDefinition/JP_Bundle_eDischargeSummary|x.y.zProfiles this resource claims to conform to |
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
| Control | 10..* |
| Type | canonical(StructureDefinition) |
| 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()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. 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()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Bundle.identifier | |
| Definition | Bundleリソースのidentifier要素は、一般に受信システム側で保存される。送信側は、後続の送信においてこのidentifierを指定することで、受信側は過去に受信したBundleリソースを特定し、それに含まれていた全データについて削除、更新などの処理を行うためにこれを使用することができる。 A persistent identifier for the bundle that won't change as a bundle is copied from server to server. |
| Short | この文書Bundleの固定識別子。Persistent identifier for the bundle |
| Comments | Bundleリソースのidentifier要素は、電子カルテ情報共有サービスへの送信の有無にかかわらず以下の通りとする。 Bundle.identifier.system : system値として、”http://jpfhir.jp/fhir/clins/bundle-identifier” を設定する。 Bundle.identifier.value : 実装ガイド本文 5情報送信仕様--Bundleリソースを識別するIdentifier要素-- に記載の[Bundle-ID]の仕様とする。 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()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. 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()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. 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 | http://jpfhir.jp/fhir/clins/bundle-identifier |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. Bundle.identifier.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | The value that is unique |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Control | 10..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. Bundle.type | |
| Definition | このバンドルの目的コード。本プロファイルでは document 固定とする。 (document | message | transaction | transaction_response | batch | batch_response | history | searchset | collection) Indicates the purpose of this bundle - how it is intended to be used. |
| Short | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection |
| 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()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 20. Bundle.timestamp | |
| Definition | このリソースを生成した日時。時刻の精度はミリ秒とし、タイムゾーンを含めること。 例:"2021-02-01T13:28:17.239+09:00" 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()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. Bundle.entry | |
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | Entry in the bundle - will have a resource or information |
| Control | 50..* |
| Type | BackboneElement |
| Is Modifier | false |
| Summary | true |
| Invariants | bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())bdl-8: fullUrl cannot be a version specific reference ( fullUrl.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()))bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists()) bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not()) 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: |
| 24. 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())ele-1: All FHIR elements must have a @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 | |
| Slice Name | composition |
| Definition | compositionリソースのエントリー。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | documentタイプのBundleリソースの先頭entryはCompositionリソース。Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 28. 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())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 30. Bundle.entry:composition.fullUrl | |
| Definition | 埋め込まれているCompositionリソースを一意に識別するためのUUID。 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 | 埋め込まれているCompositionリソースを一意に識別するためのUUIDURI 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()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 32. Bundle.entry:composition.resource | |
| Definition | Compositionリソースのインスタンス本体。 The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
| Short | Compositionリソースのインスタンス本体A 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(JP_Composition_eDischargeSummary) |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| 34. Bundle.entry:patient | |
| Slice Name | patient |
| Definition | Patientリソースのエントリー。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | PatientリソースEntry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 36. 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())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 38. Bundle.entry:patient.fullUrl | |
| Definition | 埋め込まれているPatientリソースを一意に識別するためのUUID。 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 | 埋め込まれているPatientリソースを一意に識別するためのUUIDURI 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()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 40. Bundle.entry:patient.resource | |
| Definition | Patientリソースのインスタンス本体。 The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
| Short | Patientリソースのインスタンス本体A resource in the bundle |
| Comments | 本プロファイルは、患者を識別するidentifierとして、被保険者個人識別子を必須としている。また、name.family, name.given, gender, birthDate, address.text, address.city, address.stateを必須としている。 |
| Control | 10..1 |
| Type | PatientResource(JP_Patient_eCS) |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Alternate Names | SubjectOfCare Client Resident |
| 42. Bundle.entry:practitioners | |
| Slice Name | practitioners |
| Definition | 正当な権限があって文書を作成した個人を表すPractitionerリソースで記述する。 authorisedAuthorRole要素が参照するPractitionerRoleから参照される。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 正当な権限があって文書を作成した個人の情報Entry in the bundle - will have a resource or information |
| Control | 10..* |
| 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 44. Bundle.entry:practitioners.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())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 46. Bundle.entry:practitioners.fullUrl | |
| Definition | 埋め込まれているPractitionerリソースを一意に識別するためのUUID。 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 | 埋め込まれているPractitionerリソースを一意に識別するためのUUIDURI 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()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 48. Bundle.entry:practitioners.resource | |
| Definition | Practitionerリソースのインスタンス本体。 The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
| Short | Practitionerリソースのインスタンス本体A resource in the bundle |
| Control | 10..1 |
| Type | PractitionerResource(JP_Practitioner_eCS) |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| 50. Bundle.entry:organization | |
| Slice Name | organization |
| Definition | 文書作成機関/文書管理機関 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 文書作成機関/文書管理機関Entry in the bundle - will have a resource or information |
| Control | 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 52. 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())ele-1: All FHIR elements must have a @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:organization.resource | |
| Definition | 2文書5情報や診療サマリーなどで記録する医療機関(および診療科情報)の格納に使用する The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
| Short | 2文書5情報や診療サマリーなどで記録する医療機関(および診療科情報)の格納に使用するA resource in the bundle |
| Comments | 広義の医療機関すなわち健康医療介護等にかかわる組織(調剤薬局、健診機関などを含む)の格納に使用できる。機関の中の部署、診療科のような部分組織には、本プロファイルを使用しない。機関に所属する診療科や部署・チームの情報を含めて記述する場合には、本プロファイルではJP_eCS_Department拡張を使用して、必ず所属機関の情報の一部とすること。 |
| Control | 0..1 |
| Type | OrganizationResource(JP_Organization_eCS) |
| Is Modifier | false |
| Summary | false |
| 56. Bundle.entry:encounter | |
| Slice Name | encounter |
| Definition | 入院期間中や退院時の詳細情報のEncounterリソースを参照。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 入院期間中や退院時の詳細情報のEncounterリソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. 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())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 60. Bundle.entry:encounter.resource | |
| Definition | 診療情報提供では、紹介理由を記述する受診時情報. 診療サマリーではサマリー対象となる受診や入院に関する受診時または入院時情報。診療5情報において埋め込みリソースとして記述する場合にも適用できる。 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 | EncounterResource(JP_Encounter-eCS) |
| Is Modifier | false |
| Summary | false |
| Alternate Names | Visit |
| 62. Bundle.entry:location | |
| Slice Name | location |
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | Entry in the bundle - will have a resource or information |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 64. Bundle.entry:location.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @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:location.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 | LocationResource(JP Core Location Profile) |
| Is Modifier | false |
| Summary | false |
| 68. Bundle.entry:condition | |
| Slice Name | condition |
| Definition | 必須。患者状態(入院時、退院時など)診断病名、主訴などを記述する。1つにつき1つのConditionで記述されたものを参照する。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 患者状態(入院時、退院時など)診断病名、主訴など。Entry in the bundle - will have a resource or information |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 70. 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())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 72. Bundle.entry:condition.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 | ConditionResource(JP_Condition_eCS) |
| Is Modifier | false |
| Summary | false |
| 74. Bundle.entry:allergy | |
| Slice Name | allergy |
| Definition | アレルギー・不耐性反応情報を記述して参照する。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | アレルギー・不耐性反応情報を記述したAllergyIntoleranceリソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 76. Bundle.entry:allergy.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())ele-1: All FHIR elements must have a @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:allergy.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 |
| Comments | 薬剤アレルギー等情報かアレルギー情報かの区別はcategory要素がmedicationかそれ以外かによる。このプロファイルは、電子カルテ情報共有サービスに送信するために適合したプロファイルである。 |
| Control | 0..1 |
| Type | AllergyIntoleranceResource(JP_AllergyIntolerance_eCS) |
| Is Modifier | false |
| Summary | false |
| Alternate Names | Allergy, Intolerance, Adverse Reaction |
| 80. Bundle.entry:familyHistory | |
| Slice Name | familyHistory |
| Definition | 家族歴情報情報を記述して参照する。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 家族歴情報を記述したFamilyMemberHistoryリソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 82. Bundle.entry:familyHistory.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())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 84. Bundle.entry:familyHistory.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 | Information about patient's relatives, relevant for patient. 患者の家族に関する情報のうち、患者に関連する情報(家族歴)A resource in the bundle |
| Control | 0..1 |
| Type | FamilyMemberHistoryResource(JP Core FamilyMemberHistory Profile) |
| Is Modifier | false |
| Summary | false |
| 86. Bundle.entry:observation | |
| Slice Name | observation |
| Definition | 身体所見/感染症情報/社会歴・生活習慣情報/検査結果を記述して参照する。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 身体所見/感染症情報/社会歴・生活習慣情報/検査結果を記述したObservationリソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 88. Bundle.entry:observation.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())ele-1: All FHIR elements must have a @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:observation.resource | |
| Definition | 患者、デバイス、またはその他の対象について行われた測定と簡単な観察事実(assertion)。 The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
| Short | 測定や簡単な観察事実(assertion)A resource in the bundle |
| Comments | すべてのObservation(検査測定や観察事実)の共通部分のプロファイル |
| Control | 0..1 |
| Type | ObservationResource(JP Core Observation Common Profile) |
| Is Modifier | false |
| Summary | false |
| Alternate Names | Vital Signs, Measurement, Results, Tests |
| 92. Bundle.entry:immunization | |
| Slice Name | immunization |
| Definition | 予防接種歴情報を記述して参照する。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 予防接種歴情報を記述したImmunizationリソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 94. Bundle.entry:immunization.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 96. Bundle.entry:immunization.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 | ImmunizationResource(JP_Immunization_eCS) |
| Is Modifier | false |
| Summary | false |
| 98. 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 | 手術処置/輸血歴情報/処置等を記述したProcedureリソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 100. 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())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 102. Bundle.entry:procedure.resource | |
| Definition | 患者に対して、または患者のために実行されているか実行されたアクション。これは、手術のような身体的介入、または長期サービス、カウンセリング、催眠療法のような低侵襲性である可能性がある。 The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
| Short | ProcedureリソースA resource in the bundle |
| Control | 0..1 |
| Type | ProcedureResource(JP_Procedure_eCS) |
| Is Modifier | false |
| Summary | false |
| 104. Bundle.entry:medicationRequest | |
| Slice Name | medicationRequest |
| Definition | 処方情報を記述して参照する。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 処方情報を記述したMedicationRequestリソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 106. Bundle.entry:medicationRequest.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 108. Bundle.entry:medicationRequest.resource | |
| Definition | 患者への薬の供給と内服・外用薬剤処方の指示を共に提供するオーダ。ケアプランやワークフローパターンとハーモナイズし、入院や外来でも使えるようにするため、このリソースは"MedicationPrescription"や"MedicationOrder"ではなく、"MedicationRequest"と呼ばれる。MedicationRequestプロファイルからの派生プロファイルである。 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 | MedicationRequestResource(JP Core MedicationRequest Profile) |
| Is Modifier | false |
| Summary | false |
| Alternate Names | Prescription, Order |
| 110. Bundle.entry:medicationBundle | |
| Slice Name | medicationBundle |
| Definition | 処方箋のBudle文書を参照する。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 処方箋のBudle文書Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 112. Bundle.entry:medicationBundle.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())ele-1: All FHIR elements must have a @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:medicationBundle.resource | |
| Definition | A container for a collection of resources. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
| Short | Contains a collection of resourcesA resource in the bundle |
| Control | 0..1 |
| Type | BundleResource(JP_Bundle) |
| Is Modifier | false |
| Summary | false |
| 116. 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 | DocumentReferenceリソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 118. 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())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 120. Bundle.entry:documentReference.resource | |
| Definition | あらゆる目的のためのあらゆる種類の文書への参照。ドキュメントを検出および管理できるように、ドキュメントに関するMetadataを提供します。ドキュメントの範囲は、MIMEタイプを備えたセラル化オブジェクトであるため、正式な患者中心のドキュメント(CDA)、Cliical Notes、スキャンされた論文、およびポリシーテキストなどの非患者固有の文書が含まれています。 / 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 | ドキュメントへの参照 / A reference to a documentA resource in the bundle |
| Comments | 通常、これはFHIRによって定義されたもの以外のドキュメントに使用されます。 / Usually, this is used for documents other than those defined by FHIR. |
| Control | 0..1 |
| Type | DocumentReferenceResource(JP_DocumentReference_eCS) |
| Is Modifier | false |
| Summary | false |
| 122. Bundle.entry:carePlan | |
| Slice Name | carePlan |
| Definition | 診療方針指示を記述して参照する。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 診療方針指示を記述したCarePlanリソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 124. Bundle.entry:carePlan.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 126. Bundle.entry:carePlan.resource | |
| Definition | 1人または複数の医療従事者が特定の患者、グループ、またはコミュニティに一定期間ケアを提供する意図を述べ、特定の状態または一連の状態に限定される場合がある。 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 | CarePlanResource(JP_CarePlan_eCS) |
| Is Modifier | false |
| Summary | false |
| Alternate Names | Care Team |
| 128. Bundle.entry:medicalDeviceUse | |
| Slice Name | medicalDeviceUse |
| Definition | 医療機器の使用状況を記述したDeviceUseStatementリソースを参照する。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 医療機器の使用状況を記述したDeviceUseStatementリソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 130. Bundle.entry:medicalDeviceUse.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())ele-1: All FHIR elements must have a @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:medicalDeviceUse.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 | DeviceUseStatementResource(JP_DeviceUseStatement) |
| Is Modifier | false |
| Summary | false |
| 134. Bundle.entry:medicalDevice | |
| Slice Name | medicalDevice |
| Definition | 医療機器情報を記述したDeviceリソースを参照する。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 医療機器情報を記述したDeviceリソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 136. Bundle.entry:medicalDevice.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())ele-1: All FHIR elements must have a @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:medicalDevice.resource | |
| Definition | その活動によって実質的に変更されることなく、ヘルスケアの提供に使用される製造されたアイテムの一種。このデバイスは、医療または非医療デバイスである場合があります。 / A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
| Short | ヘルスケアで使用されるアイテム / Item used in healthcareA resource in the bundle |
| Control | 0..1 |
| Type | DeviceResource(JP_Device) |
| Is Modifier | false |
| Summary | false |
| 140. Bundle.entry:imageStudy | |
| Slice Name | imageStudy |
| Definition | 画像検査医療機器情報を記述したImagingStudyリソースを参照する。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 画像検査情報を記述したImagingStudyリソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 142. Bundle.entry:imageStudy.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())ele-1: All FHIR elements must have a @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:imageStudy.resource | |
| Definition | DICOM画像研究で生成されたコンテンツの表現。 研究には、共通の文脈で収集または生成されたサービスオブジェクトペアインスタンス(SOPインスタンス - 画像またはその他のデータ)のセットで構成される一連のシリーズが含まれます。 シリーズは1つのモダリティのみ(X線、CT、MR、超音波など)、研究には複数の異なるモダリティのシリーズが含まれる場合があります。 The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
| Short | DICOM画像検査で作成されたコンテンツの表現。スタディは一連のシリーズで構成され、各シリーズには、共通のコンテキストで取得または生成された一連のサービスオブジェクトペアインスタンス(SOPインスタンス-画像またはその他のデータ)が含まれる、シリーズは1つのモダリティ(X線、CT、MR、超音波など)のみだがスタディには複数の異なるモダリティのシリーズが含まれる場合があるA resource in the bundle |
| Control | 0..1 |
| Type | ImagingStudyResource(JP Core ImagingStudy Radiology Profile) |
| Is Modifier | false |
| Summary | false |
| 146. Bundle.entry:diagReport | |
| Slice Name | diagReport |
| Definition | 診断レポート情報を記述したDiagnosticReportリソースを参照する。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 診断レポート情報を記述したDiagnosticReportリソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 148. Bundle.entry:diagReport.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())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 150. Bundle.entry:diagReport.resource | |
| Definition | 患者、患者のグループ、デバイス、場所、これらから派生した検体に対して実行された診断的検査の結果と解釈。レポートには、依頼情報や依頼者情報などの臨床コンテキスト(文脈)、および1項目単位の結果、画像、テキストとコード化された解釈、および診断レポートのフォーマットされた表現のいくつかの組み合わせが含まれる。 The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
| Short | 診断レポート-依頼情報、1項目単位の結果、画像、解釈、およびフォーマットされたレポートの組み合わせ【詳細参照】A resource in the bundle |
| Comments | これは単一のレポートをキャプチャすることを目的としており、複数のレポートをカバーする要約情報の表示に使用するのには適していない。たとえば、このリソースは、検査結果の累積レポート形式やシーケンスの詳細な構造化レポート用に作られていない。 |
| Control | 0..1 |
| Type | DiagnosticReportResource(JP Core DiagnosticReport Common Profile) |
| Is Modifier | false |
| Summary | false |
| Alternate Names | Report, Test, Result, Results, Labs, Laboratory |
| 152. Bundle.entry:advancedDirective | |
| Slice Name | advancedDirective |
| Definition | 事前指示を記述して参照する。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 事前指示を記述したConcentリソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 154. Bundle.entry:advancedDirective.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())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 156. Bundle.entry:advancedDirective.resource | |
| Definition | 特定の目的と期間のために、特定のポリシーコンテキスト内で特定のアクションを実行できるように、特定された受信者または受信者の役割を許可または否定する医療消費者の選択の記録。 / A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
| Short | 特定の目的と期間のためにアクションを実行するための受信者または役割を許可または拒否するヘルスケア消費者の選択 / A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of timeA resource in the bundle |
| Comments | 大まかに、患者には3つの重要な同意領域があります。情報の共有に関する同意(別名プライバシー同意指令 - 情報を収集、使用、または開示する許可)、特定の治療または治療の種類、および一般的な事前ケア指令の同意。 / Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives. |
| Control | 0..1 |
| Type | ConsentResource(JP_Consent) |
| Is Modifier | false |
| Summary | false |
| 158. Bundle.entry:researchSubject | |
| Slice Name | researchSubject |
| Definition | 臨床研究参加者情報を記述して参照する。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 臨床研究参加情報者を記述したResearchSubject_リソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 160. Bundle.entry:researchSubject.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())ele-1: All FHIR elements must have a @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:researchSubject.resource | |
| Definition | 研究における運用上および/または管理上の関心の主要な単位である物理的エンティティ。 / A physical entity which is the primary unit of operational and/or administrative interest in a study. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
| Short | 研究に関心のある主要な単位である物理的実体 / Physical entity which is the primary unit of interest in the studyA resource in the bundle |
| Comments | 公衆衛生研究を網羅することを確認する必要があります。 / Need to make sure we encompass public health studies. |
| Control | 0..1 |
| Type | ResearchSubjectResource(JP_ResearchSubject) |
| Is Modifier | false |
| Summary | false |
| Alternate Names | Study Subject |
| 164. Bundle.entry:researchStudy | |
| Slice Name | researchStudy |
| Definition | 臨床研究情報を記述して参照する。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 臨床研究情報を記述したResearchStudyリソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 166. Bundle.entry:researchStudy.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())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 168. Bundle.entry:researchStudy.resource | |
| Definition | 研究者または組織が、医療関連の知識の分野を増やすことを目的とした一連のステップを計画し、実行するプロセス。これには、安全性、有効性、比較有効性、および薬、デバイス、治療、その他の介入および調査手法に関するその他の情報の研究が含まれます。研究の研究には、人間または動物の被験者に関する情報の収集が含まれます。 / A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
| Short | 医療関連の患者に依存しない知識を高めるための調査 / Investigation to increase healthcare-related patient-independent knowledgeA resource in the bundle |
| Comments | 公衆衛生研究を網羅することを確認する必要があります。 / Need to make sure we encompass public health studies. |
| Control | 0..1 |
| Type | ResearchStudyResource(JP_ResearchStudy) |
| Is Modifier | false |
| Summary | false |
| Alternate Names | Clinical Trial, Study |
| 170. 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 | 親族情報を記述したRelatedPersonリソースを参照Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 172. 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())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 174. Bundle.entry:relatedPerson.resource | |
| Definition | 患者のケアに関与しているが、ヘルスケアの標的ではなく、ケアプロセスに正式な責任を負う人に関する情報。 / Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
| Short | 患者に関連しているが、ケアの直接的な標的ではない人 / A person that is related to a patient, but who is not a direct target of careA resource in the bundle |
| Control | 0..1 |
| Type | RelatedPersonResource(JP_RelatedPerson) |
| Is Modifier | false |
| Summary | false |
| 176. Bundle.entry:bundleData | |
| Slice Name | bundleData |
| Definition | 各種のBudle文書を参照する。 An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Short | 各種のBudle文書Entry 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()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 178. Bundle.entry:bundleData.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())ele-1: All FHIR elements must have a @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:bundleData.resource | |
| Definition | A container for a collection of resources. The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
| Short | Contains a collection of resourcesA resource in the bundle |
| Control | 0..1 |
| Type | BundleResource(JP_Bundle) |
| Is Modifier | false |
| Summary | false |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Bundle | |
| Definition | 退院時サマリーのための文書 Bundleリソース |
| Short | 退院時サマリーのための文書 Bundleリソース |
| Invariants | valid-system-bundleIdenfifier: R02151:Bundle.identifier.sysyemは、http://jpfhir.jp/fhir/clins/bundle-identifier (identifier.where(system='http://jpfhir.jp/fhir/clins/bundle-identifier').exists())valid-value-bundleIdenfifier: R2152:Bundle.identifier.value は、医療機関番号10桁^西暦4件^36文字以内の半角文字列(英字、数字、ハイフン記号のみ可)であること。'^[0-4][0-9][1-3][0-9]{7}[\^]20[2-3][0-9][\^][A-Za-z0-9\-]{1,36}$' ( (identifier.where(system = 'http://jpfhir.jp/fhir/clins/bundle-identifier').count()=1 and identifier.where(system = 'http://jpfhir.jp/fhir/clins/bundle-identifier').value.matches('^[0-4][0-9][1-3][0-9]{7}[\\^]20[2-3][0-9][\\^][A-Za-z0-9\\-]{1,36}$')))validEntryProfile-MedicationRequest: Bundle-entry-MedicationRequest: Bundleのentryとして含まれるMedicationRequestは、プロファイルJP_MedicationRequest_eCSのいずれかのバージョンに準拠していなければならない。 ( (entry.resource.ofType(MedicationRequest).exists().not()) or ((entry.resource.ofType(MedicationRequest).meta.profile.where(($this.indexOf('|')>0 and ($this.substring(0,$this.indexOf('|'))!='http://jpfhir.jp/fhir/eCS/StructureDefinition/JP_MedicationRequest_eCS'))).exists()).not() ) and ((entry.resource.ofType(MedicationRequest).meta.profile.where(($this.indexOf('|')<=0 and ($this!='http://jpfhir.jp/fhir/eCS/StructureDefinition/JP_MedicationRequest_eCS'))).exists()).not() )) |
| 2. Bundle.meta | |
| Control | 1..? |
| Must Support | true |
| 4. Bundle.meta.lastUpdated | |
| Control | 1..? |
| Must Support | true |
| 6. Bundle.meta.profile | |
| Definition | 準拠しているプロファイルとして次のURLとバージョンを指定する。バージョン指定を省略した場合には、データ受信時点の最新バージョンとみなされる。http://jpfhir.jp/fhir/clins/StructureDefinition/JP_Bundle_eDischargeSummary|x.y.z |
| Short | 準拠しているプロファイルとして次のURLとバージョンを指定する。バージョン指定を省略した場合には、データ受信時点の最新バージョンとみなされる。http://jpfhir.jp/fhir/clins/StructureDefinition/JP_Bundle_eDischargeSummary|x.y.z |
| Control | 1..? |
| Must Support | true |
| 8. Bundle.identifier | |
| Definition | Bundleリソースのidentifier要素は、一般に受信システム側で保存される。送信側は、後続の送信においてこのidentifierを指定することで、受信側は過去に受信したBundleリソースを特定し、それに含まれていた全データについて削除、更新などの処理を行うためにこれを使用することができる。 |
| Short | この文書Bundleの固定識別子。 |
| Comments | Bundleリソースのidentifier要素は、電子カルテ情報共有サービスへの送信の有無にかかわらず以下の通りとする。 Bundle.identifier.system : system値として、”http://jpfhir.jp/fhir/clins/bundle-identifier” を設定する。 Bundle.identifier.value : 実装ガイド本文 5情報送信仕様--Bundleリソースを識別するIdentifier要素-- に記載の[Bundle-ID]の仕様とする。 |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..? |
| Must Support | true |
| 10. Bundle.identifier.system | |
| Control | 1..? |
| Must Support | true |
| Fixed Value | http://jpfhir.jp/fhir/clins/bundle-identifier |
| 12. Bundle.identifier.value | |
| Control | 1..? |
| Must Support | true |
| 14. Bundle.type | |
| Definition | このバンドルの目的コード。本プロファイルでは document 固定とする。 (document | message | transaction | transaction_response | batch | batch_response | history | searchset | collection) |
| Must Support | true |
| Fixed Value | document |
| 16. Bundle.timestamp | |
| Definition | このリソースを生成した日時。時刻の精度はミリ秒とし、タイムゾーンを含めること。 例:"2021-02-01T13:28:17.239+09:00" |
| Short | このバンドルリソースのインスタンスが作成された日時。 |
| Control | 1..? |
| Must Support | true |
| 18. Bundle.entry | |
| Control | 5..? |
| 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:composition | |
| Slice Name | composition |
| Definition | compositionリソースのエントリー。 |
| Short | documentタイプのBundleリソースの先頭entryはCompositionリソース。 |
| Control | 1..1 |
| Must Support | true |
| 22. Bundle.entry:composition.fullUrl | |
| Definition | 埋め込まれているCompositionリソースを一意に識別するためのUUID。 |
| Short | 埋め込まれているCompositionリソースを一意に識別するためのUUID |
| Control | 1..? |
| Must Support | true |
| 24. Bundle.entry:composition.resource | |
| Definition | Compositionリソースのインスタンス本体。 |
| Short | Compositionリソースのインスタンス本体 |
| Control | 1..? |
| Type | Composition(JP_Composition_eDischargeSummary) |
| Must Support | true |
| 26. Bundle.entry:patient | |
| Slice Name | patient |
| Definition | Patientリソースのエントリー。 |
| Short | Patientリソース |
| Control | 1..1 |
| Must Support | true |
| 28. Bundle.entry:patient.fullUrl | |
| Definition | 埋め込まれているPatientリソースを一意に識別するためのUUID。 |
| Short | 埋め込まれているPatientリソースを一意に識別するためのUUID |
| Control | 1..? |
| Must Support | true |
| 30. Bundle.entry:patient.resource | |
| Definition | Patientリソースのインスタンス本体。 |
| Short | Patientリソースのインスタンス本体 |
| Control | 1..? |
| Type | Patient(JP_Patient_eCS) |
| Must Support | true |
| 32. Bundle.entry:practitioners | |
| Slice Name | practitioners |
| Definition | 正当な権限があって文書を作成した個人を表すPractitionerリソースで記述する。 authorisedAuthorRole要素が参照するPractitionerRoleから参照される。 |
| Short | 正当な権限があって文書を作成した個人の情報 |
| Control | 1..* |
| Must Support | true |
| 34. Bundle.entry:practitioners.fullUrl | |
| Definition | 埋め込まれているPractitionerリソースを一意に識別するためのUUID。 |
| Short | 埋め込まれているPractitionerリソースを一意に識別するためのUUID |
| Control | 1..? |
| Must Support | true |
| 36. Bundle.entry:practitioners.resource | |
| Definition | Practitionerリソースのインスタンス本体。 |
| Short | Practitionerリソースのインスタンス本体 |
| Control | 1..? |
| Type | Practitioner(JP_Practitioner_eCS) |
| Must Support | true |
| 38. Bundle.entry:organization | |
| Slice Name | organization |
| Definition | 文書作成機関/文書管理機関 |
| Short | 文書作成機関/文書管理機関 |
| Control | 1..* |
| Must Support | true |
| 40. Bundle.entry:organization.resource | |
| Type | Organization(JP_Organization_eCS) |
| 42. Bundle.entry:encounter | |
| Slice Name | encounter |
| Definition | 入院期間中や退院時の詳細情報のEncounterリソースを参照。 |
| Short | 入院期間中や退院時の詳細情報のEncounterリソースを参照 |
| Control | 1..1 |
| Must Support | true |
| 44. Bundle.entry:encounter.resource | |
| Type | Encounter(JP_Encounter-eCS) |
| 46. Bundle.entry:location | |
| Slice Name | location |
| Control | 0..* |
| Must Support | true |
| 48. Bundle.entry:location.resource | |
| Type | Location(JP Core Location Profile) |
| 50. Bundle.entry:condition | |
| Slice Name | condition |
| Definition | 必須。患者状態(入院時、退院時など)診断病名、主訴などを記述する。1つにつき1つのConditionで記述されたものを参照する。 |
| Short | 患者状態(入院時、退院時など)診断病名、主訴など。 |
| Control | 0..* |
| Must Support | true |
| 52. Bundle.entry:condition.resource | |
| Type | Condition(JP_Condition_eCS) |
| 54. Bundle.entry:allergy | |
| Slice Name | allergy |
| Definition | アレルギー・不耐性反応情報を記述して参照する。 |
| Short | アレルギー・不耐性反応情報を記述したAllergyIntoleranceリソースを参照 |
| Control | 0..* |
| Must Support | true |
| 56. Bundle.entry:allergy.resource | |
| Type | AllergyIntolerance(JP_AllergyIntolerance_eCS) |
| 58. Bundle.entry:familyHistory | |
| Slice Name | familyHistory |
| Definition | 家族歴情報情報を記述して参照する。 |
| Short | 家族歴情報を記述したFamilyMemberHistoryリソースを参照 |
| Control | 0..* |
| Must Support | true |
| 60. Bundle.entry:familyHistory.resource | |
| Type | FamilyMemberHistory(JP Core FamilyMemberHistory Profile) |
| 62. Bundle.entry:observation | |
| Slice Name | observation |
| Definition | 身体所見/感染症情報/社会歴・生活習慣情報/検査結果を記述して参照する。 |
| Short | 身体所見/感染症情報/社会歴・生活習慣情報/検査結果を記述したObservationリソースを参照 |
| Control | 0..* |
| Must Support | true |
| 64. Bundle.entry:observation.resource | |
| Type | Observation(JP Core Observation Common Profile) |
| 66. Bundle.entry:immunization | |
| Slice Name | immunization |
| Definition | 予防接種歴情報を記述して参照する。 |
| Short | 予防接種歴情報を記述したImmunizationリソースを参照 |
| Control | 0..* |
| Must Support | true |
| 68. Bundle.entry:immunization.resource | |
| Type | Immunization(JP_Immunization_eCS) |
| 70. Bundle.entry:procedure | |
| Slice Name | procedure |
| Definition | 手術処置/輸血歴情報/処置等を記述して参照する。 |
| Short | 手術処置/輸血歴情報/処置等を記述したProcedureリソースを参照 |
| Control | 0..* |
| Must Support | true |
| 72. Bundle.entry:procedure.resource | |
| Type | Procedure(JP_Procedure_eCS) |
| 74. Bundle.entry:medicationRequest | |
| Slice Name | medicationRequest |
| Definition | 処方情報を記述して参照する。 |
| Short | 処方情報を記述したMedicationRequestリソースを参照 |
| Control | 0..* |
| Must Support | true |
| 76. Bundle.entry:medicationRequest.resource | |
| Type | MedicationRequest(JP Core MedicationRequest Profile) |
| 78. Bundle.entry:medicationBundle | |
| Slice Name | medicationBundle |
| Definition | 処方箋のBudle文書を参照する。 |
| Short | 処方箋のBudle文書 |
| Control | 0..* |
| Must Support | true |
| 80. Bundle.entry:medicationBundle.resource | |
| Type | Bundle(JP_Bundle) |
| 82. Bundle.entry:documentReference | |
| Slice Name | documentReference |
| Definition | 臨床経過を記述して参照する。 |
| Short | DocumentReferenceリソースを参照 |
| Control | 0..* |
| Must Support | true |
| 84. Bundle.entry:documentReference.resource | |
| Type | DocumentReference(JP_DocumentReference_eCS) |
| 86. Bundle.entry:carePlan | |
| Slice Name | carePlan |
| Definition | 診療方針指示を記述して参照する。 |
| Short | 診療方針指示を記述したCarePlanリソースを参照 |
| Control | 0..* |
| Must Support | true |
| 88. Bundle.entry:carePlan.resource | |
| Type | CarePlan(JP_CarePlan_eCS) |
| 90. Bundle.entry:medicalDeviceUse | |
| Slice Name | medicalDeviceUse |
| Definition | 医療機器の使用状況を記述したDeviceUseStatementリソースを参照する。 |
| Short | 医療機器の使用状況を記述したDeviceUseStatementリソースを参照 |
| Control | 0..* |
| Must Support | true |
| 92. Bundle.entry:medicalDeviceUse.resource | |
| Type | DeviceUseStatement(JP_DeviceUseStatement) |
| 94. Bundle.entry:medicalDevice | |
| Slice Name | medicalDevice |
| Definition | 医療機器情報を記述したDeviceリソースを参照する。 |
| Short | 医療機器情報を記述したDeviceリソースを参照 |
| Control | 0..* |
| Must Support | true |
| 96. Bundle.entry:medicalDevice.resource | |
| Type | Device(JP_Device) |
| 98. Bundle.entry:imageStudy | |
| Slice Name | imageStudy |
| Definition | 画像検査医療機器情報を記述したImagingStudyリソースを参照する。 |
| Short | 画像検査情報を記述したImagingStudyリソースを参照 |
| Control | 0..* |
| Must Support | true |
| 100. Bundle.entry:imageStudy.resource | |
| Type | ImagingStudy(JP Core ImagingStudy Radiology Profile) |
| 102. Bundle.entry:diagReport | |
| Slice Name | diagReport |
| Definition | 診断レポート情報を記述したDiagnosticReportリソースを参照する。 |
| Short | 診断レポート情報を記述したDiagnosticReportリソースを参照 |
| Control | 0..* |
| Must Support | true |
| 104. Bundle.entry:diagReport.resource | |
| Type | DiagnosticReport(JP Core DiagnosticReport Common Profile) |
| 106. Bundle.entry:advancedDirective | |
| Slice Name | advancedDirective |
| Definition | 事前指示を記述して参照する。 |
| Short | 事前指示を記述したConcentリソースを参照 |
| Control | 0..* |
| Must Support | true |
| 108. Bundle.entry:advancedDirective.resource | |
| Type | Consent(JP_Consent) |
| 110. Bundle.entry:researchSubject | |
| Slice Name | researchSubject |
| Definition | 臨床研究参加者情報を記述して参照する。 |
| Short | 臨床研究参加情報者を記述したResearchSubject_リソースを参照 |
| Control | 0..* |
| Must Support | true |
| 112. Bundle.entry:researchSubject.resource | |
| Type | ResearchSubject(JP_ResearchSubject) |
| 114. Bundle.entry:researchStudy | |
| Slice Name | researchStudy |
| Definition | 臨床研究情報を記述して参照する。 |
| Short | 臨床研究情報を記述したResearchStudyリソースを参照 |
| Control | 0..* |
| Must Support | true |
| 116. Bundle.entry:researchStudy.resource | |
| Type | ResearchStudy(JP_ResearchStudy) |
| 118. Bundle.entry:relatedPerson | |
| Slice Name | relatedPerson |
| Definition | 親族情報を記述して参照する。 |
| Short | 親族情報を記述したRelatedPersonリソースを参照 |
| Control | 0..* |
| Must Support | true |
| 120. Bundle.entry:relatedPerson.resource | |
| Type | RelatedPerson(JP_RelatedPerson) |
| 122. Bundle.entry:bundleData | |
| Slice Name | bundleData |
| Definition | 各種のBudle文書を参照する。 |
| Short | 各種のBudle文書 |
| Control | 0..* |
| Must Support | true |
| 124. Bundle.entry:bundleData.resource | |
| Type | Bundle(JP_Bundle) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Bundle | |||||
| Definition | 退院時サマリーのための文書 Bundleリソース | ||||
| Short | 退院時サマリーのための文書 Bundleリソース | ||||
| Control | 0..* | ||||
| 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))valid-system-bundleIdenfifier: R02151:Bundle.identifier.sysyemは、http://jpfhir.jp/fhir/clins/bundle-identifier ( identifier.where(system='http://jpfhir.jp/fhir/clins/bundle-identifier').exists())valid-value-bundleIdenfifier: R2152:Bundle.identifier.value は、医療機関番号10桁^西暦4件^36文字以内の半角文字列(英字、数字、ハイフン記号のみ可)であること。'^[0-4][0-9][1-3][0-9]{7}[\^]20[2-3][0-9][\^][A-Za-z0-9\-]{1,36}$' ( (identifier.where(system = 'http://jpfhir.jp/fhir/clins/bundle-identifier').count()=1 and identifier.where(system = 'http://jpfhir.jp/fhir/clins/bundle-identifier').value.matches('^[0-4][0-9][1-3][0-9]{7}[\\^]20[2-3][0-9][\\^][A-Za-z0-9\\-]{1,36}$')))validEntryProfile-MedicationRequest: Bundle-entry-MedicationRequest: Bundleのentryとして含まれるMedicationRequestは、プロファイルJP_MedicationRequest_eCSのいずれかのバージョンに準拠していなければならない。 ( (entry.resource.ofType(MedicationRequest).exists().not()) or ((entry.resource.ofType(MedicationRequest).meta.profile.where(($this.indexOf('|')>0 and ($this.substring(0,$this.indexOf('|'))!='http://jpfhir.jp/fhir/eCS/StructureDefinition/JP_MedicationRequest_eCS'))).exists()).not() ) and ((entry.resource.ofType(MedicationRequest).meta.profile.where(($this.indexOf('|')<=0 and ($this!='http://jpfhir.jp/fhir/eCS/StructureDefinition/JP_MedicationRequest_eCS'))).exists()).not() )) | ||||
| 2. Bundle.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 4. Bundle.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 1..1 | ||||
| Type | Meta | ||||
| 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())) | ||||
| 6. Bundle.meta.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 | ||||
| 8. Bundle.meta.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.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 10. Bundle.meta.versionId | |||||
| Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||||
| Short | Version specific identifier | ||||
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 12. Bundle.meta.lastUpdated | |||||
| Definition | When the resource last changed - e.g. when the version changed. | ||||
| Short | When the resource version last changed | ||||
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | ||||
| 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())) | ||||
| 14. Bundle.meta.source | |||||
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | ||||
| Short | Identifies where the resource comes from | ||||
| Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at 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())) | ||||
| 16. Bundle.meta.profile | |||||
| Definition | 準拠しているプロファイルとして次のURLとバージョンを指定する。バージョン指定を省略した場合には、データ受信時点の最新バージョンとみなされる。http://jpfhir.jp/fhir/clins/StructureDefinition/JP_Bundle_eDischargeSummary|x.y.z | ||||
| Short | 準拠しているプロファイルとして次のURLとバージョンを指定する。バージョン指定を省略した場合には、データ受信時点の最新バージョンとみなされる。http://jpfhir.jp/fhir/clins/StructureDefinition/JP_Bundle_eDischargeSummary|x.y.z | ||||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
| Control | 1..* | ||||
| Type | canonical(StructureDefinition) | ||||
| 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.meta.security | |||||
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
| Short | Security Labels applied to this resource | ||||
| Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 20. Bundle.meta.tag | |||||
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
| Short | Tags applied to this resource | ||||
| Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 22. 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())) | ||||
| 24. Bundle.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 26. Bundle.identifier | |||||
| Definition | Bundleリソースのidentifier要素は、一般に受信システム側で保存される。送信側は、後続の送信においてこのidentifierを指定することで、受信側は過去に受信したBundleリソースを特定し、それに含まれていた全データについて削除、更新などの処理を行うためにこれを使用することができる。 | ||||
| Short | この文書Bundleの固定識別子。 | ||||
| Comments | Bundleリソースのidentifier要素は、電子カルテ情報共有サービスへの送信の有無にかかわらず以下の通りとする。 Bundle.identifier.system : system値として、”http://jpfhir.jp/fhir/clins/bundle-identifier” を設定する。 Bundle.identifier.value : 実装ガイド本文 5情報送信仕様--Bundleリソースを識別するIdentifier要素-- に記載の[Bundle-ID]の仕様とする。 | ||||
| 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())) | ||||
| 28. 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 | ||||
| 30. 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: | ||||
| 32. 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())) | ||||
| 34. Bundle.identifier.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Description of identifier | ||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 36. 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 | http://jpfhir.jp/fhir/clins/bundle-identifier | ||||
| Example | General: http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 38. Bundle.identifier.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | The value that is unique | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Example | General: 123456 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 40. 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())) | ||||
| 42. 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())) | ||||
| 44. Bundle.type | |||||
| Definition | このバンドルの目的コード。本プロファイルでは document 固定とする。 (document | message | transaction | transaction_response | batch | batch_response | history | searchset | collection) | ||||
| Short | document | 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 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())) | ||||
| 46. Bundle.timestamp | |||||
| Definition | このリソースを生成した日時。時刻の精度はミリ秒とし、タイムゾーンを含めること。 例:"2021-02-01T13:28:17.239+09:00" | ||||
| Short | このバンドルリソースのインスタンスが作成された日時。 | ||||
| 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())) | ||||
| 48. 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())) | ||||
| 50. 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())) | ||||
| 52. 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 | ||||
| 54. 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()) | ||||
| 56. 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()) | ||||
| 58. 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())) | ||||
| 60. 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())) | ||||
| 62. Bundle.entry | |||||
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). | ||||
| Short | Entry in the bundle - will have a resource or information | ||||
| Control | 5..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())bdl-8: fullUrl cannot be a version specific reference ( fullUrl.contains('/_history/').not())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Bundle.entry. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 64. 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 | ||||
| 66. 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()) | ||||
| 68. 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()) | ||||
| 70. 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())) | ||||
| 72. 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())) | ||||
| 74. 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 | ||||
| 76. 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())) | ||||
| 78. 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 | ||||
| 80. 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()) | ||||
| 82. 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()) | ||||
| 84. 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())) | ||||
| 86. 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())) | ||||
| 88. 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())) | ||||
| 90. 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 | ||||
| 92. 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()) | ||||
| 94. 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()) | ||||
| 96. 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())) | ||||
| 98. 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())) | ||||
| 100. 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())) | ||||
| 102. 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())) | ||||
| 104. 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())) | ||||
| 106. 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())) | ||||
| 108. 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())) | ||||
| 110. 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 | ||||
| 112. 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()) | ||||
| 114. 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()) | ||||
| 116. 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())) | ||||
| 118. 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())) | ||||
| 120. 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())) | ||||
| 122. 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())) | ||||
| 124. 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 | ||||
| 126. Bundle.entry:composition | |||||
| Slice Name | composition | ||||
| Definition | compositionリソースのエントリー。 | ||||
| Short | documentタイプのBundleリソースの先頭entryは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())) | ||||
| 128. 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 | ||||
| 130. 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()) | ||||
| 132. 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()) | ||||
| 134. 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())) | ||||
| 136. Bundle.entry:composition.fullUrl | |||||
| Definition | 埋め込まれているCompositionリソースを一意に識別するためのUUID。 | ||||
| Short | 埋め込まれているCompositionリソースを一意に識別するためのUUID | ||||
| 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())) | ||||
| 138. Bundle.entry:composition.resource | |||||
| Definition | Compositionリソースのインスタンス本体。 | ||||
| Short | 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(JP_Composition_eDischargeSummary) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| 140. 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())) | ||||
| 142. 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 | ||||
| 144. 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()) | ||||
| 146. 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()) | ||||
| 148. 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())) | ||||
| 150. 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())) | ||||
| 152. 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())) | ||||
| 154. 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 | ||||
| 156. 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()) | ||||
| 158. 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()) | ||||
| 160. 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())) | ||||
| 162. 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())) | ||||
| 164. 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())) | ||||
| 166. 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())) | ||||
| 168. 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())) | ||||
| 170. 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())) | ||||
| 172. 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())) | ||||
| 174. 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 | ||||
| 176. 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()) | ||||
| 178. 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()) | ||||
| 180. 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())) | ||||
| 182. 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())) | ||||
| 184. 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())) | ||||
| 186. 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())) | ||||
| 188. 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 | ||||
| 190. Bundle.entry:patient | |||||
| Slice Name | patient | ||||
| Definition | Patientリソースのエントリー。 | ||||
| Short | Patientリソース | ||||
| 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())) | ||||
| 192. Bundle.entry:patient.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 194. Bundle.entry:patient.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 196. 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()) | ||||
| 198. Bundle.entry:patient.link | |||||
| Definition | A series of links that provide context to this entry. | ||||
| Short | Links related to this entry | ||||
| Control | 0..* | ||||
| Type | Seettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 200. Bundle.entry:patient.fullUrl | |||||
| Definition | 埋め込まれているPatientリソースを一意に識別するためのUUID。 | ||||
| Short | 埋め込まれているPatientリソースを一意に識別するためのUUID | ||||
| 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())) | ||||
| 202. Bundle.entry:patient.resource | |||||
| Definition | Patientリソースのインスタンス本体。 | ||||
| Short | Patientリソースのインスタンス本体 | ||||
| Comments | 本プロファイルは、患者を識別するidentifierとして、被保険者個人識別子を必須としている。また、name.family, name.given, gender, birthDate, address.text, address.city, address.stateを必須としている。 | ||||
| Control | 1..1 | ||||
| Type | Patient(JP_Patient_eCS) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Alternate Names | SubjectOfCare Client Resident | ||||
| 204. Bundle.entry:patient.search | |||||
| Definition | Information about the search process that lead to the creation of this entry. | ||||
| Short | Search related information | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-2 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 206. Bundle.entry:patient.search.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 208. Bundle.entry:patient.search.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 210. Bundle.entry:patient.search.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 212. Bundle.entry:patient.search.mode | |||||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Short | match | include | outcome - why this is in the result set | ||||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from SearchEntryMode (required to http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1)Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 214. Bundle.entry:patient.search.score | |||||
| Definition | When searching, the server's search ranking score for the entry. | ||||
| Short | Search ranking (between 0 and 1) | ||||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 216. Bundle.entry:patient.request | |||||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||||
| Short | Additional execution information (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-3 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 218. Bundle.entry:patient.request.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 220. Bundle.entry:patient.request.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 222. Bundle.entry:patient.request.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 224. Bundle.entry:patient.request.method | |||||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 226. Bundle.entry:patient.request.url | |||||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||||
| Short | URL for HTTP equivalent of this entry | ||||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 228. Bundle.entry:patient.request.ifNoneMatch | |||||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 230. Bundle.entry:patient.request.ifModifiedSince | |||||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 232. Bundle.entry:patient.request.ifMatch | |||||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||||
| Short | For managing update contention | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 234. Bundle.entry:patient.request.ifNoneExist | |||||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||||
| Short | For conditional creates | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 236. Bundle.entry:patient.response | |||||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||||
| Short | Results of execution (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-4 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 238. Bundle.entry:patient.response.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 240. Bundle.entry:patient.response.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 242. Bundle.entry:patient.response.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 244. Bundle.entry:patient.response.status | |||||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||||
| Short | Status response code (text optional) | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 246. Bundle.entry:patient.response.location | |||||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||||
| Short | The location (if the operation returns a location) | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 248. Bundle.entry:patient.response.etag | |||||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||||
| Short | The Etag for the resource (if relevant) | ||||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 250. Bundle.entry:patient.response.lastModified | |||||
| Definition | The date/time that the resource was modified on the server. | ||||
| Short | Server's date time modified | ||||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 252. Bundle.entry:patient.response.outcome | |||||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||||
| Control | 0..1 | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 254. Bundle.entry:practitioners | |||||
| Slice Name | practitioners | ||||
| Definition | 正当な権限があって文書を作成した個人を表すPractitionerリソースで記述する。 authorisedAuthorRole要素が参照するPractitionerRoleから参照される。 | ||||
| Short | 正当な権限があって文書を作成した個人の情報 | ||||
| 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())) | ||||
| 256. Bundle.entry:practitioners.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 | ||||
| 258. Bundle.entry:practitioners.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()) | ||||
| 260. Bundle.entry:practitioners.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()) | ||||
| 262. Bundle.entry:practitioners.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())) | ||||
| 264. Bundle.entry:practitioners.fullUrl | |||||
| Definition | 埋め込まれているPractitionerリソースを一意に識別するためのUUID。 | ||||
| Short | 埋め込まれているPractitionerリソースを一意に識別するためのUUID | ||||
| 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())) | ||||
| 266. Bundle.entry:practitioners.resource | |||||
| Definition | Practitionerリソースのインスタンス本体。 | ||||
| Short | Practitionerリソースのインスタンス本体 | ||||
| Control | 1..1 | ||||
| Type | Practitioner(JP_Practitioner_eCS) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| 268. Bundle.entry:practitioners.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())) | ||||
| 270. Bundle.entry:practitioners.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 | ||||
| 272. Bundle.entry:practitioners.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()) | ||||
| 274. Bundle.entry:practitioners.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()) | ||||
| 276. Bundle.entry:practitioners.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())) | ||||
| 278. Bundle.entry:practitioners.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())) | ||||
| 280. Bundle.entry:practitioners.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())) | ||||
| 282. Bundle.entry:practitioners.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 | ||||
| 284. Bundle.entry:practitioners.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()) | ||||
| 286. Bundle.entry:practitioners.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()) | ||||
| 288. Bundle.entry:practitioners.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())) | ||||
| 290. Bundle.entry:practitioners.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())) | ||||
| 292. Bundle.entry:practitioners.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())) | ||||
| 294. Bundle.entry:practitioners.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())) | ||||
| 296. Bundle.entry:practitioners.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())) | ||||
| 298. Bundle.entry:practitioners.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())) | ||||
| 300. Bundle.entry:practitioners.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())) | ||||
| 302. Bundle.entry:practitioners.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 | ||||
| 304. Bundle.entry:practitioners.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()) | ||||
| 306. Bundle.entry:practitioners.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()) | ||||
| 308. Bundle.entry:practitioners.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())) | ||||
| 310. Bundle.entry:practitioners.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())) | ||||
| 312. Bundle.entry:practitioners.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())) | ||||
| 314. Bundle.entry:practitioners.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())) | ||||
| 316. Bundle.entry:practitioners.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 | ||||
| 318. Bundle.entry:organization | |||||
| Slice Name | organization | ||||
| Definition | 文書作成機関/文書管理機関 | ||||
| Short | 文書作成機関/文書管理機関 | ||||
| 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())) | ||||
| 320. Bundle.entry:organization.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 322. Bundle.entry:organization.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 324. 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()) | ||||
| 326. Bundle.entry:organization.link | |||||
| Definition | A series of links that provide context to this entry. | ||||
| Short | Links related to this entry | ||||
| Control | 0..* | ||||
| Type | Seettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 328. Bundle.entry:organization.fullUrl | |||||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||||
| Control | 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())) | ||||
| 330. Bundle.entry:organization.resource | |||||
| Definition | 2文書5情報や診療サマリーなどで記録する医療機関(および診療科情報)の格納に使用する | ||||
| Short | 2文書5情報や診療サマリーなどで記録する医療機関(および診療科情報)の格納に使用する | ||||
| Comments | 広義の医療機関すなわち健康医療介護等にかかわる組織(調剤薬局、健診機関などを含む)の格納に使用できる。機関の中の部署、診療科のような部分組織には、本プロファイルを使用しない。機関に所属する診療科や部署・チームの情報を含めて記述する場合には、本プロファイルではJP_eCS_Department拡張を使用して、必ず所属機関の情報の一部とすること。 | ||||
| Control | 0..1 | ||||
| Type | Organization(JP_Organization_eCS) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 332. Bundle.entry:organization.search | |||||
| Definition | Information about the search process that lead to the creation of this entry. | ||||
| Short | Search related information | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-2 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 334. Bundle.entry:organization.search.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 336. Bundle.entry:organization.search.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 338. Bundle.entry:organization.search.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 340. Bundle.entry:organization.search.mode | |||||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Short | match | include | outcome - why this is in the result set | ||||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from SearchEntryMode (required to http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1)Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 342. Bundle.entry:organization.search.score | |||||
| Definition | When searching, the server's search ranking score for the entry. | ||||
| Short | Search ranking (between 0 and 1) | ||||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 344. Bundle.entry:organization.request | |||||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||||
| Short | Additional execution information (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-3 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 346. Bundle.entry:organization.request.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 348. Bundle.entry:organization.request.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 350. Bundle.entry:organization.request.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 352. Bundle.entry:organization.request.method | |||||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 354. Bundle.entry:organization.request.url | |||||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||||
| Short | URL for HTTP equivalent of this entry | ||||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 356. Bundle.entry:organization.request.ifNoneMatch | |||||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 358. Bundle.entry:organization.request.ifModifiedSince | |||||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 360. Bundle.entry:organization.request.ifMatch | |||||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||||
| Short | For managing update contention | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 362. Bundle.entry:organization.request.ifNoneExist | |||||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||||
| Short | For conditional creates | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 364. Bundle.entry:organization.response | |||||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||||
| Short | Results of execution (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-4 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 366. Bundle.entry:organization.response.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 368. Bundle.entry:organization.response.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 370. Bundle.entry:organization.response.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 372. Bundle.entry:organization.response.status | |||||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||||
| Short | Status response code (text optional) | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 374. Bundle.entry:organization.response.location | |||||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||||
| Short | The location (if the operation returns a location) | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 376. Bundle.entry:organization.response.etag | |||||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||||
| Short | The Etag for the resource (if relevant) | ||||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 378. Bundle.entry:organization.response.lastModified | |||||
| Definition | The date/time that the resource was modified on the server. | ||||
| Short | Server's date time modified | ||||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 380. Bundle.entry:organization.response.outcome | |||||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||||
| Control | 0..1 | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 382. Bundle.entry:encounter | |||||
| Slice Name | encounter | ||||
| Definition | 入院期間中や退院時の詳細情報のEncounterリソースを参照。 | ||||
| Short | 入院期間中や退院時の詳細情報のEncounterリソースを参照 | ||||
| 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())) | ||||
| 384. 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 | ||||
| 386. 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()) | ||||
| 388. 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()) | ||||
| 390. 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())) | ||||
| 392. Bundle.entry:encounter.fullUrl | |||||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||||
| Control | 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())) | ||||
| 394. Bundle.entry:encounter.resource | |||||
| Definition | 診療情報提供では、紹介理由を記述する受診時情報. 診療サマリーではサマリー対象となる受診や入院に関する受診時または入院時情報。診療5情報において埋め込みリソースとして記述する場合にも適用できる。 | ||||
| Short | ー | ||||
| Control | 0..1 | ||||
| Type | Encounter(JP_Encounter-eCS) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | Visit | ||||
| 396. 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())) | ||||
| 398. 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 | ||||
| 400. 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()) | ||||
| 402. 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()) | ||||
| 404. 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())) | ||||
| 406. 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())) | ||||
| 408. 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())) | ||||
| 410. 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 | ||||
| 412. 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()) | ||||
| 414. 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()) | ||||
| 416. Bundle.entry:encounter.request.method | |||||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 418. Bundle.entry:encounter.request.url | |||||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||||
| Short | URL for HTTP equivalent of this entry | ||||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 420. Bundle.entry:encounter.request.ifNoneMatch | |||||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 422. Bundle.entry:encounter.request.ifModifiedSince | |||||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 424. Bundle.entry:encounter.request.ifMatch | |||||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||||
| Short | For managing update contention | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 426. Bundle.entry:encounter.request.ifNoneExist | |||||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||||
| Short | For conditional creates | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 428. Bundle.entry:encounter.response | |||||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||||
| Short | Results of execution (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-4 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 430. Bundle.entry:encounter.response.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 432. Bundle.entry:encounter.response.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 434. Bundle.entry:encounter.response.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 436. Bundle.entry:encounter.response.status | |||||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||||
| Short | Status response code (text optional) | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 438. Bundle.entry:encounter.response.location | |||||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||||
| Short | The location (if the operation returns a location) | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 440. Bundle.entry:encounter.response.etag | |||||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||||
| Short | The Etag for the resource (if relevant) | ||||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 442. Bundle.entry:encounter.response.lastModified | |||||
| Definition | The date/time that the resource was modified on the server. | ||||
| Short | Server's date time modified | ||||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 444. Bundle.entry:encounter.response.outcome | |||||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||||
| Control | 0..1 | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 446. Bundle.entry:location | |||||
| Slice Name | location | ||||
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). | ||||
| Short | Entry in the bundle - will have a resource or information | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 448. Bundle.entry:location.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 450. Bundle.entry:location.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 452. Bundle.entry:location.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 454. Bundle.entry:location.link | |||||
| Definition | A series of links that provide context to this entry. | ||||
| Short | Links related to this entry | ||||
| Control | 0..* | ||||
| Type | Seettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 456. Bundle.entry:location.fullUrl | |||||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||||
| Control | 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())) | ||||
| 458. Bundle.entry:location.resource | |||||
| Definition | サービスが提供され、リソースとそれに関わる人たちが存在する物理的な場所の詳細情報と位置情報。 | ||||
| Short | 物理的な場所の詳細情報と位置情報 | ||||
| Control | 0..1 | ||||
| Type | Location(JP Core Location Profile) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 460. Bundle.entry:location.search | |||||
| Definition | Information about the search process that lead to the creation of this entry. | ||||
| Short | Search related information | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-2 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 462. Bundle.entry:location.search.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 464. Bundle.entry:location.search.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 466. Bundle.entry:location.search.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 468. Bundle.entry:location.search.mode | |||||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Short | match | include | outcome - why this is in the result set | ||||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from SearchEntryMode (required to http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1)Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 470. Bundle.entry:location.search.score | |||||
| Definition | When searching, the server's search ranking score for the entry. | ||||
| Short | Search ranking (between 0 and 1) | ||||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 472. Bundle.entry:location.request | |||||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||||
| Short | Additional execution information (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-3 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 474. Bundle.entry:location.request.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 476. Bundle.entry:location.request.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 478. Bundle.entry:location.request.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 480. Bundle.entry:location.request.method | |||||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 482. Bundle.entry:location.request.url | |||||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||||
| Short | URL for HTTP equivalent of this entry | ||||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 484. Bundle.entry:location.request.ifNoneMatch | |||||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 486. Bundle.entry:location.request.ifModifiedSince | |||||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 488. Bundle.entry:location.request.ifMatch | |||||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||||
| Short | For managing update contention | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 490. Bundle.entry:location.request.ifNoneExist | |||||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||||
| Short | For conditional creates | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 492. Bundle.entry:location.response | |||||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||||
| Short | Results of execution (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-4 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 494. Bundle.entry:location.response.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 496. Bundle.entry:location.response.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 498. Bundle.entry:location.response.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 500. Bundle.entry:location.response.status | |||||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||||
| Short | Status response code (text optional) | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 502. Bundle.entry:location.response.location | |||||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||||
| Short | The location (if the operation returns a location) | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 504. Bundle.entry:location.response.etag | |||||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||||
| Short | The Etag for the resource (if relevant) | ||||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 506. Bundle.entry:location.response.lastModified | |||||
| Definition | The date/time that the resource was modified on the server. | ||||
| Short | Server's date time modified | ||||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 508. Bundle.entry:location.response.outcome | |||||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||||
| Control | 0..1 | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 510. Bundle.entry:condition | |||||
| Slice Name | condition | ||||
| Definition | 必須。患者状態(入院時、退院時など)診断病名、主訴などを記述する。1つにつき1つのConditionで記述されたものを参照する。 | ||||
| Short | 患者状態(入院時、退院時など)診断病名、主訴など。 | ||||
| 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())) | ||||
| 512. Bundle.entry:condition.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 514. Bundle.entry:condition.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 516. 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()) | ||||
| 518. Bundle.entry:condition.link | |||||
| Definition | A series of links that provide context to this entry. | ||||
| Short | Links related to this entry | ||||
| Control | 0..* | ||||
| Type | Seettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 520. Bundle.entry:condition.fullUrl | |||||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||||
| Control | 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())) | ||||
| 522. Bundle.entry:condition.resource | |||||
| Definition | 診療情報における傷病名情報の格納に使用する | ||||
| Short | 診療情報における傷病名情報の格納に使用する | ||||
| Control | 0..1 | ||||
| Type | Condition(JP_Condition_eCS) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 524. Bundle.entry:condition.search | |||||
| Definition | Information about the search process that lead to the creation of this entry. | ||||
| Short | Search related information | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-2 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 526. Bundle.entry:condition.search.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 528. Bundle.entry:condition.search.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 530. Bundle.entry:condition.search.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 532. Bundle.entry:condition.search.mode | |||||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Short | match | include | outcome - why this is in the result set | ||||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from SearchEntryMode (required to http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1)Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 534. Bundle.entry:condition.search.score | |||||
| Definition | When searching, the server's search ranking score for the entry. | ||||
| Short | Search ranking (between 0 and 1) | ||||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 536. Bundle.entry:condition.request | |||||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||||
| Short | Additional execution information (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-3 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 538. Bundle.entry:condition.request.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 540. Bundle.entry:condition.request.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 542. Bundle.entry:condition.request.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 544. Bundle.entry:condition.request.method | |||||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 546. Bundle.entry:condition.request.url | |||||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||||
| Short | URL for HTTP equivalent of this entry | ||||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 548. Bundle.entry:condition.request.ifNoneMatch | |||||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 550. Bundle.entry:condition.request.ifModifiedSince | |||||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 552. Bundle.entry:condition.request.ifMatch | |||||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||||
| Short | For managing update contention | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 554. Bundle.entry:condition.request.ifNoneExist | |||||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||||
| Short | For conditional creates | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 556. Bundle.entry:condition.response | |||||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||||
| Short | Results of execution (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-4 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 558. Bundle.entry:condition.response.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 560. Bundle.entry:condition.response.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 562. Bundle.entry:condition.response.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 564. Bundle.entry:condition.response.status | |||||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||||
| Short | Status response code (text optional) | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 566. Bundle.entry:condition.response.location | |||||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||||
| Short | The location (if the operation returns a location) | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 568. Bundle.entry:condition.response.etag | |||||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||||
| Short | The Etag for the resource (if relevant) | ||||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 570. Bundle.entry:condition.response.lastModified | |||||
| Definition | The date/time that the resource was modified on the server. | ||||
| Short | Server's date time modified | ||||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 572. Bundle.entry:condition.response.outcome | |||||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||||
| Control | 0..1 | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 574. Bundle.entry:allergy | |||||
| Slice Name | allergy | ||||
| Definition | アレルギー・不耐性反応情報を記述して参照する。 | ||||
| Short | アレルギー・不耐性反応情報を記述したAllergyIntoleranceリソースを参照 | ||||
| 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())) | ||||
| 576. Bundle.entry:allergy.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 | ||||
| 578. Bundle.entry:allergy.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()) | ||||
| 580. Bundle.entry:allergy.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()) | ||||
| 582. Bundle.entry:allergy.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())) | ||||
| 584. Bundle.entry:allergy.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())) | ||||
| 586. Bundle.entry:allergy.resource | |||||
| Definition | 診療情報におけるアレルギー情報の格納に使用する | ||||
| Short | 診療情報におけるアレルギー情報の格納に使用する | ||||
| Comments | 薬剤アレルギー等情報かアレルギー情報かの区別はcategory要素がmedicationかそれ以外かによる。このプロファイルは、電子カルテ情報共有サービスに送信するために適合したプロファイルである。 | ||||
| Control | 0..1 | ||||
| Type | AllergyIntolerance(JP_AllergyIntolerance_eCS) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | Allergy, Intolerance, Adverse Reaction | ||||
| 588. Bundle.entry:allergy.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())) | ||||
| 590. Bundle.entry:allergy.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 | ||||
| 592. Bundle.entry:allergy.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()) | ||||
| 594. Bundle.entry:allergy.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()) | ||||
| 596. Bundle.entry:allergy.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())) | ||||
| 598. Bundle.entry:allergy.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())) | ||||
| 600. Bundle.entry:allergy.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())) | ||||
| 602. Bundle.entry:allergy.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 | ||||
| 604. Bundle.entry:allergy.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()) | ||||
| 606. Bundle.entry:allergy.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()) | ||||
| 608. Bundle.entry:allergy.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())) | ||||
| 610. Bundle.entry:allergy.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())) | ||||
| 612. Bundle.entry:allergy.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())) | ||||
| 614. Bundle.entry:allergy.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())) | ||||
| 616. Bundle.entry:allergy.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())) | ||||
| 618. Bundle.entry:allergy.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())) | ||||
| 620. Bundle.entry:allergy.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())) | ||||
| 622. Bundle.entry:allergy.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 | ||||
| 624. Bundle.entry:allergy.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()) | ||||
| 626. Bundle.entry:allergy.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()) | ||||
| 628. Bundle.entry:allergy.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())) | ||||
| 630. Bundle.entry:allergy.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())) | ||||
| 632. Bundle.entry:allergy.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())) | ||||
| 634. Bundle.entry:allergy.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())) | ||||
| 636. Bundle.entry:allergy.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 | ||||
| 638. Bundle.entry:familyHistory | |||||
| Slice Name | familyHistory | ||||
| Definition | 家族歴情報情報を記述して参照する。 | ||||
| Short | 家族歴情報を記述したFamilyMemberHistoryリソースを参照 | ||||
| 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())) | ||||
| 640. Bundle.entry:familyHistory.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 | ||||
| 642. Bundle.entry:familyHistory.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()) | ||||
| 644. Bundle.entry:familyHistory.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()) | ||||
| 646. Bundle.entry:familyHistory.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())) | ||||
| 648. Bundle.entry:familyHistory.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())) | ||||
| 650. Bundle.entry:familyHistory.resource | |||||
| Definition | Significant health conditions for a person related to the patient relevant in the context of care for the patient. | ||||
| Short | Information about patient's relatives, relevant for patient. 患者の家族に関する情報のうち、患者に関連する情報(家族歴) | ||||
| Control | 0..1 | ||||
| Type | FamilyMemberHistory(JP Core FamilyMemberHistory Profile) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 652. Bundle.entry:familyHistory.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())) | ||||
| 654. Bundle.entry:familyHistory.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 | ||||
| 656. Bundle.entry:familyHistory.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()) | ||||
| 658. Bundle.entry:familyHistory.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()) | ||||
| 660. Bundle.entry:familyHistory.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())) | ||||
| 662. Bundle.entry:familyHistory.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())) | ||||
| 664. Bundle.entry:familyHistory.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())) | ||||
| 666. Bundle.entry:familyHistory.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 | ||||
| 668. Bundle.entry:familyHistory.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()) | ||||
| 670. Bundle.entry:familyHistory.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()) | ||||
| 672. Bundle.entry:familyHistory.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())) | ||||
| 674. Bundle.entry:familyHistory.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())) | ||||
| 676. Bundle.entry:familyHistory.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())) | ||||
| 678. Bundle.entry:familyHistory.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())) | ||||
| 680. Bundle.entry:familyHistory.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())) | ||||
| 682. Bundle.entry:familyHistory.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())) | ||||
| 684. Bundle.entry:familyHistory.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())) | ||||
| 686. Bundle.entry:familyHistory.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 | ||||
| 688. Bundle.entry:familyHistory.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()) | ||||
| 690. Bundle.entry:familyHistory.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()) | ||||
| 692. Bundle.entry:familyHistory.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())) | ||||
| 694. Bundle.entry:familyHistory.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())) | ||||
| 696. Bundle.entry:familyHistory.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())) | ||||
| 698. Bundle.entry:familyHistory.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())) | ||||
| 700. Bundle.entry:familyHistory.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 | ||||
| 702. Bundle.entry:observation | |||||
| Slice Name | observation | ||||
| Definition | 身体所見/感染症情報/社会歴・生活習慣情報/検査結果を記述して参照する。 | ||||
| Short | 身体所見/感染症情報/社会歴・生活習慣情報/検査結果を記述したObservationリソースを参照 | ||||
| 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())) | ||||
| 704. Bundle.entry:observation.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 | ||||
| 706. Bundle.entry:observation.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()) | ||||
| 708. Bundle.entry:observation.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()) | ||||
| 710. Bundle.entry:observation.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())) | ||||
| 712. Bundle.entry:observation.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())) | ||||
| 714. Bundle.entry:observation.resource | |||||
| Definition | 患者、デバイス、またはその他の対象について行われた測定と簡単な観察事実(assertion)。 | ||||
| Short | 測定や簡単な観察事実(assertion) | ||||
| Comments | すべてのObservation(検査測定や観察事実)の共通部分のプロファイル | ||||
| Control | 0..1 | ||||
| Type | Observation(JP Core Observation Common Profile) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | Vital Signs, Measurement, Results, Tests | ||||
| 716. Bundle.entry:observation.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())) | ||||
| 718. Bundle.entry:observation.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 | ||||
| 720. Bundle.entry:observation.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()) | ||||
| 722. Bundle.entry:observation.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()) | ||||
| 724. Bundle.entry:observation.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())) | ||||
| 726. Bundle.entry:observation.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())) | ||||
| 728. Bundle.entry:observation.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())) | ||||
| 730. Bundle.entry:observation.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 | ||||
| 732. Bundle.entry:observation.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()) | ||||
| 734. Bundle.entry:observation.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()) | ||||
| 736. Bundle.entry:observation.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())) | ||||
| 738. Bundle.entry:observation.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())) | ||||
| 740. Bundle.entry:observation.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())) | ||||
| 742. Bundle.entry:observation.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())) | ||||
| 744. Bundle.entry:observation.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())) | ||||
| 746. Bundle.entry:observation.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())) | ||||
| 748. Bundle.entry:observation.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())) | ||||
| 750. Bundle.entry:observation.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 | ||||
| 752. Bundle.entry:observation.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()) | ||||
| 754. Bundle.entry:observation.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()) | ||||
| 756. Bundle.entry:observation.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())) | ||||
| 758. Bundle.entry:observation.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())) | ||||
| 760. Bundle.entry:observation.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())) | ||||
| 762. Bundle.entry:observation.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())) | ||||
| 764. Bundle.entry:observation.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 | ||||
| 766. Bundle.entry:immunization | |||||
| Slice Name | immunization | ||||
| Definition | 予防接種歴情報を記述して参照する。 | ||||
| Short | 予防接種歴情報を記述したImmunizationリソースを参照 | ||||
| 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())) | ||||
| 768. Bundle.entry:immunization.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 770. Bundle.entry:immunization.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 772. Bundle.entry:immunization.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 774. Bundle.entry:immunization.link | |||||
| Definition | A series of links that provide context to this entry. | ||||
| Short | Links related to this entry | ||||
| Control | 0..* | ||||
| Type | Seettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 776. Bundle.entry:immunization.fullUrl | |||||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||||
| Control | 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())) | ||||
| 778. Bundle.entry:immunization.resource | |||||
| Definition | ワクチンを接種したときの記録,あるいは予防接種について患者や医療従事者などが報告した記録。 | ||||
| Short | 予防接種 | ||||
| Control | 0..1 | ||||
| Type | Immunization(JP_Immunization_eCS) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 780. Bundle.entry:immunization.search | |||||
| Definition | Information about the search process that lead to the creation of this entry. | ||||
| Short | Search related information | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-2 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 782. Bundle.entry:immunization.search.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 784. Bundle.entry:immunization.search.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 786. Bundle.entry:immunization.search.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 788. Bundle.entry:immunization.search.mode | |||||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Short | match | include | outcome - why this is in the result set | ||||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from SearchEntryMode (required to http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1)Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 790. Bundle.entry:immunization.search.score | |||||
| Definition | When searching, the server's search ranking score for the entry. | ||||
| Short | Search ranking (between 0 and 1) | ||||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 792. Bundle.entry:immunization.request | |||||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||||
| Short | Additional execution information (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-3 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 794. Bundle.entry:immunization.request.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 796. Bundle.entry:immunization.request.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 798. Bundle.entry:immunization.request.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 800. Bundle.entry:immunization.request.method | |||||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 802. Bundle.entry:immunization.request.url | |||||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||||
| Short | URL for HTTP equivalent of this entry | ||||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 804. Bundle.entry:immunization.request.ifNoneMatch | |||||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 806. Bundle.entry:immunization.request.ifModifiedSince | |||||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 808. Bundle.entry:immunization.request.ifMatch | |||||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||||
| Short | For managing update contention | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 810. Bundle.entry:immunization.request.ifNoneExist | |||||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||||
| Short | For conditional creates | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 812. Bundle.entry:immunization.response | |||||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||||
| Short | Results of execution (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-4 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 814. Bundle.entry:immunization.response.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 816. Bundle.entry:immunization.response.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 818. Bundle.entry:immunization.response.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 820. Bundle.entry:immunization.response.status | |||||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||||
| Short | Status response code (text optional) | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 822. Bundle.entry:immunization.response.location | |||||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||||
| Short | The location (if the operation returns a location) | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 824. Bundle.entry:immunization.response.etag | |||||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||||
| Short | The Etag for the resource (if relevant) | ||||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 826. Bundle.entry:immunization.response.lastModified | |||||
| Definition | The date/time that the resource was modified on the server. | ||||
| Short | Server's date time modified | ||||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 828. Bundle.entry:immunization.response.outcome | |||||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||||
| Control | 0..1 | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 830. Bundle.entry:procedure | |||||
| Slice Name | procedure | ||||
| Definition | 手術処置/輸血歴情報/処置等を記述して参照する。 | ||||
| Short | 手術処置/輸血歴情報/処置等を記述したProcedureリソースを参照 | ||||
| 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())) | ||||
| 832. Bundle.entry:procedure.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 834. Bundle.entry:procedure.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 836. 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()) | ||||
| 838. Bundle.entry:procedure.link | |||||
| Definition | A series of links that provide context to this entry. | ||||
| Short | Links related to this entry | ||||
| Control | 0..* | ||||
| Type | Seettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 840. Bundle.entry:procedure.fullUrl | |||||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||||
| Control | 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())) | ||||
| 842. Bundle.entry:procedure.resource | |||||
| Definition | 患者に対して、または患者のために実行されているか実行されたアクション。これは、手術のような身体的介入、または長期サービス、カウンセリング、催眠療法のような低侵襲性である可能性がある。 | ||||
| Short | Procedureリソース | ||||
| Control | 0..1 | ||||
| Type | Procedure(JP_Procedure_eCS) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 844. Bundle.entry:procedure.search | |||||
| Definition | Information about the search process that lead to the creation of this entry. | ||||
| Short | Search related information | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-2 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 846. Bundle.entry:procedure.search.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 848. Bundle.entry:procedure.search.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 850. Bundle.entry:procedure.search.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 852. Bundle.entry:procedure.search.mode | |||||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Short | match | include | outcome - why this is in the result set | ||||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from SearchEntryMode (required to http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1)Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 854. Bundle.entry:procedure.search.score | |||||
| Definition | When searching, the server's search ranking score for the entry. | ||||
| Short | Search ranking (between 0 and 1) | ||||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 856. Bundle.entry:procedure.request | |||||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||||
| Short | Additional execution information (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-3 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 858. Bundle.entry:procedure.request.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 860. Bundle.entry:procedure.request.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 862. Bundle.entry:procedure.request.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 864. Bundle.entry:procedure.request.method | |||||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 866. Bundle.entry:procedure.request.url | |||||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||||
| Short | URL for HTTP equivalent of this entry | ||||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 868. Bundle.entry:procedure.request.ifNoneMatch | |||||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 870. Bundle.entry:procedure.request.ifModifiedSince | |||||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 872. Bundle.entry:procedure.request.ifMatch | |||||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||||
| Short | For managing update contention | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 874. Bundle.entry:procedure.request.ifNoneExist | |||||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||||
| Short | For conditional creates | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 876. Bundle.entry:procedure.response | |||||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||||
| Short | Results of execution (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-4 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 878. Bundle.entry:procedure.response.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 880. Bundle.entry:procedure.response.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 882. Bundle.entry:procedure.response.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 884. Bundle.entry:procedure.response.status | |||||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||||
| Short | Status response code (text optional) | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 886. Bundle.entry:procedure.response.location | |||||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||||
| Short | The location (if the operation returns a location) | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 888. Bundle.entry:procedure.response.etag | |||||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||||
| Short | The Etag for the resource (if relevant) | ||||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 890. Bundle.entry:procedure.response.lastModified | |||||
| Definition | The date/time that the resource was modified on the server. | ||||
| Short | Server's date time modified | ||||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 892. Bundle.entry:procedure.response.outcome | |||||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||||
| Control | 0..1 | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 894. Bundle.entry:medicationRequest | |||||
| Slice Name | medicationRequest | ||||
| Definition | 処方情報を記述して参照する。 | ||||
| Short | 処方情報を記述したMedicationRequestリソースを参照 | ||||
| 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())) | ||||
| 896. Bundle.entry:medicationRequest.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 898. Bundle.entry:medicationRequest.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 900. Bundle.entry:medicationRequest.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 902. Bundle.entry:medicationRequest.link | |||||
| Definition | A series of links that provide context to this entry. | ||||
| Short | Links related to this entry | ||||
| Control | 0..* | ||||
| Type | Seettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 904. Bundle.entry:medicationRequest.fullUrl | |||||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||||
| Control | 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())) | ||||
| 906. Bundle.entry:medicationRequest.resource | |||||
| Definition | 患者への薬の供給と内服・外用薬剤処方の指示を共に提供するオーダ。ケアプランやワークフローパターンとハーモナイズし、入院や外来でも使えるようにするため、このリソースは"MedicationPrescription"や"MedicationOrder"ではなく、"MedicationRequest"と呼ばれる。MedicationRequestプロファイルからの派生プロファイルである。 | ||||
| Short | 患者あるいはグループに対しての処方オーダ | ||||
| Control | 0..1 | ||||
| Type | MedicationRequest(JP Core MedicationRequest Profile) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | Prescription, Order | ||||
| 908. Bundle.entry:medicationRequest.search | |||||
| Definition | Information about the search process that lead to the creation of this entry. | ||||
| Short | Search related information | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-2 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 910. Bundle.entry:medicationRequest.search.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 912. Bundle.entry:medicationRequest.search.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 914. Bundle.entry:medicationRequest.search.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 916. Bundle.entry:medicationRequest.search.mode | |||||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Short | match | include | outcome - why this is in the result set | ||||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from SearchEntryMode (required to http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1)Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 918. Bundle.entry:medicationRequest.search.score | |||||
| Definition | When searching, the server's search ranking score for the entry. | ||||
| Short | Search ranking (between 0 and 1) | ||||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 920. Bundle.entry:medicationRequest.request | |||||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||||
| Short | Additional execution information (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-3 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 922. Bundle.entry:medicationRequest.request.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 924. Bundle.entry:medicationRequest.request.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 926. Bundle.entry:medicationRequest.request.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 928. Bundle.entry:medicationRequest.request.method | |||||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 930. Bundle.entry:medicationRequest.request.url | |||||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||||
| Short | URL for HTTP equivalent of this entry | ||||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 932. Bundle.entry:medicationRequest.request.ifNoneMatch | |||||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 934. Bundle.entry:medicationRequest.request.ifModifiedSince | |||||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 936. Bundle.entry:medicationRequest.request.ifMatch | |||||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||||
| Short | For managing update contention | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 938. Bundle.entry:medicationRequest.request.ifNoneExist | |||||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||||
| Short | For conditional creates | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 940. Bundle.entry:medicationRequest.response | |||||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||||
| Short | Results of execution (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-4 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 942. Bundle.entry:medicationRequest.response.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 944. Bundle.entry:medicationRequest.response.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 946. Bundle.entry:medicationRequest.response.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 948. Bundle.entry:medicationRequest.response.status | |||||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||||
| Short | Status response code (text optional) | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 950. Bundle.entry:medicationRequest.response.location | |||||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||||
| Short | The location (if the operation returns a location) | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 952. Bundle.entry:medicationRequest.response.etag | |||||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||||
| Short | The Etag for the resource (if relevant) | ||||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 954. Bundle.entry:medicationRequest.response.lastModified | |||||
| Definition | The date/time that the resource was modified on the server. | ||||
| Short | Server's date time modified | ||||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 956. Bundle.entry:medicationRequest.response.outcome | |||||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||||
| Control | 0..1 | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 958. Bundle.entry:medicationBundle | |||||
| Slice Name | medicationBundle | ||||
| Definition | 処方箋のBudle文書を参照する。 | ||||
| Short | 処方箋のBudle文書 | ||||
| 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())) | ||||
| 960. Bundle.entry:medicationBundle.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 | ||||
| 962. Bundle.entry:medicationBundle.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()) | ||||
| 964. Bundle.entry:medicationBundle.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()) | ||||
| 966. Bundle.entry:medicationBundle.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())) | ||||
| 968. Bundle.entry:medicationBundle.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())) | ||||
| 970. Bundle.entry:medicationBundle.resource | |||||
| Definition | A container for a collection of resources. | ||||
| Short | Contains a collection of resources | ||||
| Control | 0..1 | ||||
| Type | Bundle(JP_Bundle) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 972. Bundle.entry:medicationBundle.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())) | ||||
| 974. Bundle.entry:medicationBundle.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 | ||||
| 976. Bundle.entry:medicationBundle.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()) | ||||
| 978. Bundle.entry:medicationBundle.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()) | ||||
| 980. Bundle.entry:medicationBundle.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())) | ||||
| 982. Bundle.entry:medicationBundle.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())) | ||||
| 984. Bundle.entry:medicationBundle.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())) | ||||
| 986. Bundle.entry:medicationBundle.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 | ||||
| 988. Bundle.entry:medicationBundle.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()) | ||||
| 990. Bundle.entry:medicationBundle.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()) | ||||
| 992. Bundle.entry:medicationBundle.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())) | ||||
| 994. Bundle.entry:medicationBundle.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())) | ||||
| 996. Bundle.entry:medicationBundle.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())) | ||||
| 998. Bundle.entry:medicationBundle.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())) | ||||
| 1000. Bundle.entry:medicationBundle.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())) | ||||
| 1002. Bundle.entry:medicationBundle.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())) | ||||
| 1004. Bundle.entry:medicationBundle.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())) | ||||
| 1006. Bundle.entry:medicationBundle.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 | ||||
| 1008. Bundle.entry:medicationBundle.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()) | ||||
| 1010. Bundle.entry:medicationBundle.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()) | ||||
| 1012. Bundle.entry:medicationBundle.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())) | ||||
| 1014. Bundle.entry:medicationBundle.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())) | ||||
| 1016. Bundle.entry:medicationBundle.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())) | ||||
| 1018. Bundle.entry:medicationBundle.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())) | ||||
| 1020. Bundle.entry:medicationBundle.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 | ||||
| 1022. Bundle.entry:documentReference | |||||
| Slice Name | documentReference | ||||
| Definition | 臨床経過を記述して参照する。 | ||||
| Short | DocumentReferenceリソースを参照 | ||||
| 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())) | ||||
| 1024. Bundle.entry:documentReference.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 1026. Bundle.entry:documentReference.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1028. 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()) | ||||
| 1030. Bundle.entry:documentReference.link | |||||
| Definition | A series of links that provide context to this entry. | ||||
| Short | Links related to this entry | ||||
| Control | 0..* | ||||
| Type | Seettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1032. Bundle.entry:documentReference.fullUrl | |||||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||||
| Control | 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())) | ||||
| 1034. Bundle.entry:documentReference.resource | |||||
| Definition | あらゆる目的のためのあらゆる種類の文書への参照。ドキュメントを検出および管理できるように、ドキュメントに関するMetadataを提供します。ドキュメントの範囲は、MIMEタイプを備えたセラル化オブジェクトであるため、正式な患者中心のドキュメント(CDA)、Cliical Notes、スキャンされた論文、およびポリシーテキストなどの非患者固有の文書が含まれています。 / 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. | ||||
| Short | ドキュメントへの参照 / A reference to a document | ||||
| Comments | 通常、これはFHIRによって定義されたもの以外のドキュメントに使用されます。 / Usually, this is used for documents other than those defined by FHIR. | ||||
| Control | 0..1 | ||||
| Type | DocumentReference(JP_DocumentReference_eCS) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 1036. Bundle.entry:documentReference.search | |||||
| Definition | Information about the search process that lead to the creation of this entry. | ||||
| Short | Search related information | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-2 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1038. Bundle.entry:documentReference.search.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 1040. Bundle.entry:documentReference.search.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1042. Bundle.entry:documentReference.search.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1044. Bundle.entry:documentReference.search.mode | |||||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Short | match | include | outcome - why this is in the result set | ||||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from SearchEntryMode (required to http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1)Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1046. Bundle.entry:documentReference.search.score | |||||
| Definition | When searching, the server's search ranking score for the entry. | ||||
| Short | Search ranking (between 0 and 1) | ||||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1048. Bundle.entry:documentReference.request | |||||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||||
| Short | Additional execution information (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-3 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1050. Bundle.entry:documentReference.request.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 1052. Bundle.entry:documentReference.request.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1054. Bundle.entry:documentReference.request.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1056. Bundle.entry:documentReference.request.method | |||||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1058. Bundle.entry:documentReference.request.url | |||||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||||
| Short | URL for HTTP equivalent of this entry | ||||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1060. Bundle.entry:documentReference.request.ifNoneMatch | |||||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1062. Bundle.entry:documentReference.request.ifModifiedSince | |||||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1064. Bundle.entry:documentReference.request.ifMatch | |||||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||||
| Short | For managing update contention | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1066. Bundle.entry:documentReference.request.ifNoneExist | |||||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||||
| Short | For conditional creates | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1068. Bundle.entry:documentReference.response | |||||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||||
| Short | Results of execution (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-4 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1070. Bundle.entry:documentReference.response.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 1072. Bundle.entry:documentReference.response.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1074. Bundle.entry:documentReference.response.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1076. Bundle.entry:documentReference.response.status | |||||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||||
| Short | Status response code (text optional) | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1078. Bundle.entry:documentReference.response.location | |||||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||||
| Short | The location (if the operation returns a location) | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1080. Bundle.entry:documentReference.response.etag | |||||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||||
| Short | The Etag for the resource (if relevant) | ||||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1082. Bundle.entry:documentReference.response.lastModified | |||||
| Definition | The date/time that the resource was modified on the server. | ||||
| Short | Server's date time modified | ||||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1084. Bundle.entry:documentReference.response.outcome | |||||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||||
| Control | 0..1 | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 1086. Bundle.entry:carePlan | |||||
| Slice Name | carePlan | ||||
| Definition | 診療方針指示を記述して参照する。 | ||||
| Short | 診療方針指示を記述したCarePlanリソースを参照 | ||||
| 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())) | ||||
| 1088. Bundle.entry:carePlan.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 1090. Bundle.entry:carePlan.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1092. Bundle.entry:carePlan.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1094. Bundle.entry:carePlan.link | |||||
| Definition | A series of links that provide context to this entry. | ||||
| Short | Links related to this entry | ||||
| Control | 0..* | ||||
| Type | Seettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1096. Bundle.entry:carePlan.fullUrl | |||||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||||
| Control | 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())) | ||||
| 1098. Bundle.entry:carePlan.resource | |||||
| Definition | 1人または複数の医療従事者が特定の患者、グループ、またはコミュニティに一定期間ケアを提供する意図を述べ、特定の状態または一連の状態に限定される場合がある。 | ||||
| Short | 患者またはグループの健康計画 | ||||
| Control | 0..1 | ||||
| Type | CarePlan(JP_CarePlan_eCS) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | Care Team | ||||
| 1100. Bundle.entry:carePlan.search | |||||
| Definition | Information about the search process that lead to the creation of this entry. | ||||
| Short | Search related information | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-2 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1102. Bundle.entry:carePlan.search.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 1104. Bundle.entry:carePlan.search.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1106. Bundle.entry:carePlan.search.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1108. Bundle.entry:carePlan.search.mode | |||||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Short | match | include | outcome - why this is in the result set | ||||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from SearchEntryMode (required to http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1)Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1110. Bundle.entry:carePlan.search.score | |||||
| Definition | When searching, the server's search ranking score for the entry. | ||||
| Short | Search ranking (between 0 and 1) | ||||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1112. Bundle.entry:carePlan.request | |||||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||||
| Short | Additional execution information (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-3 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1114. Bundle.entry:carePlan.request.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 1116. Bundle.entry:carePlan.request.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1118. Bundle.entry:carePlan.request.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1120. Bundle.entry:carePlan.request.method | |||||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1122. Bundle.entry:carePlan.request.url | |||||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||||
| Short | URL for HTTP equivalent of this entry | ||||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1124. Bundle.entry:carePlan.request.ifNoneMatch | |||||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1126. Bundle.entry:carePlan.request.ifModifiedSince | |||||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1128. Bundle.entry:carePlan.request.ifMatch | |||||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||||
| Short | For managing update contention | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1130. Bundle.entry:carePlan.request.ifNoneExist | |||||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||||
| Short | For conditional creates | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1132. Bundle.entry:carePlan.response | |||||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||||
| Short | Results of execution (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-4 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1134. Bundle.entry:carePlan.response.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 1136. Bundle.entry:carePlan.response.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1138. Bundle.entry:carePlan.response.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1140. Bundle.entry:carePlan.response.status | |||||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||||
| Short | Status response code (text optional) | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1142. Bundle.entry:carePlan.response.location | |||||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||||
| Short | The location (if the operation returns a location) | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1144. Bundle.entry:carePlan.response.etag | |||||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||||
| Short | The Etag for the resource (if relevant) | ||||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1146. Bundle.entry:carePlan.response.lastModified | |||||
| Definition | The date/time that the resource was modified on the server. | ||||
| Short | Server's date time modified | ||||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1148. Bundle.entry:carePlan.response.outcome | |||||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||||
| Control | 0..1 | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 1150. Bundle.entry:medicalDeviceUse | |||||
| Slice Name | medicalDeviceUse | ||||
| Definition | 医療機器の使用状況を記述したDeviceUseStatementリソースを参照する。 | ||||
| Short | 医療機器の使用状況を記述したDeviceUseStatementリソースを参照 | ||||
| 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())) | ||||
| 1152. Bundle.entry:medicalDeviceUse.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 | ||||
| 1154. Bundle.entry:medicalDeviceUse.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()) | ||||
| 1156. Bundle.entry:medicalDeviceUse.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()) | ||||
| 1158. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1160. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1162. Bundle.entry:medicalDeviceUse.resource | |||||
| Definition | 患者が報告した情報または他の臨床医からの報告によって得られた、装置の使用記録。 | ||||
| Short | デバイスの使用記録 | ||||
| Control | 0..1 | ||||
| Type | DeviceUseStatement(JP_DeviceUseStatement) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 1164. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1166. Bundle.entry:medicalDeviceUse.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 | ||||
| 1168. Bundle.entry:medicalDeviceUse.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()) | ||||
| 1170. Bundle.entry:medicalDeviceUse.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()) | ||||
| 1172. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1174. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1176. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1178. Bundle.entry:medicalDeviceUse.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 | ||||
| 1180. Bundle.entry:medicalDeviceUse.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()) | ||||
| 1182. Bundle.entry:medicalDeviceUse.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()) | ||||
| 1184. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1186. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1188. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1190. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1192. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1194. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1196. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1198. Bundle.entry:medicalDeviceUse.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 | ||||
| 1200. Bundle.entry:medicalDeviceUse.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()) | ||||
| 1202. Bundle.entry:medicalDeviceUse.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()) | ||||
| 1204. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1206. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1208. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1210. Bundle.entry:medicalDeviceUse.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())) | ||||
| 1212. Bundle.entry:medicalDeviceUse.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 | ||||
| 1214. Bundle.entry:medicalDevice | |||||
| Slice Name | medicalDevice | ||||
| Definition | 医療機器情報を記述したDeviceリソースを参照する。 | ||||
| Short | 医療機器情報を記述したDeviceリソースを参照 | ||||
| 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())) | ||||
| 1216. Bundle.entry:medicalDevice.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 | ||||
| 1218. Bundle.entry:medicalDevice.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()) | ||||
| 1220. Bundle.entry:medicalDevice.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()) | ||||
| 1222. Bundle.entry:medicalDevice.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())) | ||||
| 1224. Bundle.entry:medicalDevice.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())) | ||||
| 1226. Bundle.entry:medicalDevice.resource | |||||
| Definition | その活動によって実質的に変更されることなく、ヘルスケアの提供に使用される製造されたアイテムの一種。このデバイスは、医療または非医療デバイスである場合があります。 / A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. | ||||
| Short | ヘルスケアで使用されるアイテム / Item used in healthcare | ||||
| Control | 0..1 | ||||
| Type | Device(JP_Device) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 1228. Bundle.entry:medicalDevice.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())) | ||||
| 1230. Bundle.entry:medicalDevice.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 | ||||
| 1232. Bundle.entry:medicalDevice.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()) | ||||
| 1234. Bundle.entry:medicalDevice.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()) | ||||
| 1236. Bundle.entry:medicalDevice.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())) | ||||
| 1238. Bundle.entry:medicalDevice.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())) | ||||
| 1240. Bundle.entry:medicalDevice.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())) | ||||
| 1242. Bundle.entry:medicalDevice.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 | ||||
| 1244. Bundle.entry:medicalDevice.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()) | ||||
| 1246. Bundle.entry:medicalDevice.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()) | ||||
| 1248. Bundle.entry:medicalDevice.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())) | ||||
| 1250. Bundle.entry:medicalDevice.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())) | ||||
| 1252. Bundle.entry:medicalDevice.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())) | ||||
| 1254. Bundle.entry:medicalDevice.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())) | ||||
| 1256. Bundle.entry:medicalDevice.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())) | ||||
| 1258. Bundle.entry:medicalDevice.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())) | ||||
| 1260. Bundle.entry:medicalDevice.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())) | ||||
| 1262. Bundle.entry:medicalDevice.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 | ||||
| 1264. Bundle.entry:medicalDevice.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()) | ||||
| 1266. Bundle.entry:medicalDevice.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()) | ||||
| 1268. Bundle.entry:medicalDevice.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())) | ||||
| 1270. Bundle.entry:medicalDevice.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())) | ||||
| 1272. Bundle.entry:medicalDevice.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())) | ||||
| 1274. Bundle.entry:medicalDevice.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())) | ||||
| 1276. Bundle.entry:medicalDevice.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 | ||||
| 1278. Bundle.entry:imageStudy | |||||
| Slice Name | imageStudy | ||||
| Definition | 画像検査医療機器情報を記述したImagingStudyリソースを参照する。 | ||||
| Short | 画像検査情報を記述したImagingStudyリソースを参照 | ||||
| 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())) | ||||
| 1280. Bundle.entry:imageStudy.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 | ||||
| 1282. Bundle.entry:imageStudy.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()) | ||||
| 1284. Bundle.entry:imageStudy.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()) | ||||
| 1286. Bundle.entry:imageStudy.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())) | ||||
| 1288. Bundle.entry:imageStudy.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())) | ||||
| 1290. Bundle.entry:imageStudy.resource | |||||
| Definition | DICOM画像研究で生成されたコンテンツの表現。 研究には、共通の文脈で収集または生成されたサービスオブジェクトペアインスタンス(SOPインスタンス - 画像またはその他のデータ)のセットで構成される一連のシリーズが含まれます。 シリーズは1つのモダリティのみ(X線、CT、MR、超音波など)、研究には複数の異なるモダリティのシリーズが含まれる場合があります。 | ||||
| Short | DICOM画像検査で作成されたコンテンツの表現。スタディは一連のシリーズで構成され、各シリーズには、共通のコンテキストで取得または生成された一連のサービスオブジェクトペアインスタンス(SOPインスタンス-画像またはその他のデータ)が含まれる、シリーズは1つのモダリティ(X線、CT、MR、超音波など)のみだがスタディには複数の異なるモダリティのシリーズが含まれる場合がある | ||||
| Control | 0..1 | ||||
| Type | ImagingStudy(JP Core ImagingStudy Radiology Profile) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 1292. Bundle.entry:imageStudy.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())) | ||||
| 1294. Bundle.entry:imageStudy.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 | ||||
| 1296. Bundle.entry:imageStudy.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()) | ||||
| 1298. Bundle.entry:imageStudy.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()) | ||||
| 1300. Bundle.entry:imageStudy.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())) | ||||
| 1302. Bundle.entry:imageStudy.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())) | ||||
| 1304. Bundle.entry:imageStudy.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())) | ||||
| 1306. Bundle.entry:imageStudy.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 | ||||
| 1308. Bundle.entry:imageStudy.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()) | ||||
| 1310. Bundle.entry:imageStudy.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()) | ||||
| 1312. Bundle.entry:imageStudy.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())) | ||||
| 1314. Bundle.entry:imageStudy.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())) | ||||
| 1316. Bundle.entry:imageStudy.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())) | ||||
| 1318. Bundle.entry:imageStudy.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())) | ||||
| 1320. Bundle.entry:imageStudy.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())) | ||||
| 1322. Bundle.entry:imageStudy.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())) | ||||
| 1324. Bundle.entry:imageStudy.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())) | ||||
| 1326. Bundle.entry:imageStudy.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 | ||||
| 1328. Bundle.entry:imageStudy.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()) | ||||
| 1330. Bundle.entry:imageStudy.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()) | ||||
| 1332. Bundle.entry:imageStudy.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())) | ||||
| 1334. Bundle.entry:imageStudy.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())) | ||||
| 1336. Bundle.entry:imageStudy.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())) | ||||
| 1338. Bundle.entry:imageStudy.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())) | ||||
| 1340. Bundle.entry:imageStudy.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 | ||||
| 1342. Bundle.entry:diagReport | |||||
| Slice Name | diagReport | ||||
| Definition | 診断レポート情報を記述したDiagnosticReportリソースを参照する。 | ||||
| Short | 診断レポート情報を記述したDiagnosticReportリソースを参照 | ||||
| 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())) | ||||
| 1344. Bundle.entry:diagReport.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 | ||||
| 1346. Bundle.entry:diagReport.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()) | ||||
| 1348. Bundle.entry:diagReport.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()) | ||||
| 1350. Bundle.entry:diagReport.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())) | ||||
| 1352. Bundle.entry:diagReport.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())) | ||||
| 1354. Bundle.entry:diagReport.resource | |||||
| Definition | 患者、患者のグループ、デバイス、場所、これらから派生した検体に対して実行された診断的検査の結果と解釈。レポートには、依頼情報や依頼者情報などの臨床コンテキスト(文脈)、および1項目単位の結果、画像、テキストとコード化された解釈、および診断レポートのフォーマットされた表現のいくつかの組み合わせが含まれる。 | ||||
| Short | 診断レポート-依頼情報、1項目単位の結果、画像、解釈、およびフォーマットされたレポートの組み合わせ【詳細参照】 | ||||
| Comments | これは単一のレポートをキャプチャすることを目的としており、複数のレポートをカバーする要約情報の表示に使用するのには適していない。たとえば、このリソースは、検査結果の累積レポート形式やシーケンスの詳細な構造化レポート用に作られていない。 | ||||
| Control | 0..1 | ||||
| Type | DiagnosticReport(JP Core DiagnosticReport Common Profile) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | Report, Test, Result, Results, Labs, Laboratory | ||||
| 1356. Bundle.entry:diagReport.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())) | ||||
| 1358. Bundle.entry:diagReport.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 | ||||
| 1360. Bundle.entry:diagReport.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()) | ||||
| 1362. Bundle.entry:diagReport.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()) | ||||
| 1364. Bundle.entry:diagReport.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())) | ||||
| 1366. Bundle.entry:diagReport.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())) | ||||
| 1368. Bundle.entry:diagReport.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())) | ||||
| 1370. Bundle.entry:diagReport.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 | ||||
| 1372. Bundle.entry:diagReport.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()) | ||||
| 1374. Bundle.entry:diagReport.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()) | ||||
| 1376. Bundle.entry:diagReport.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())) | ||||
| 1378. Bundle.entry:diagReport.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())) | ||||
| 1380. Bundle.entry:diagReport.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())) | ||||
| 1382. Bundle.entry:diagReport.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())) | ||||
| 1384. Bundle.entry:diagReport.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())) | ||||
| 1386. Bundle.entry:diagReport.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())) | ||||
| 1388. Bundle.entry:diagReport.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())) | ||||
| 1390. Bundle.entry:diagReport.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 | ||||
| 1392. Bundle.entry:diagReport.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()) | ||||
| 1394. Bundle.entry:diagReport.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()) | ||||
| 1396. Bundle.entry:diagReport.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())) | ||||
| 1398. Bundle.entry:diagReport.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())) | ||||
| 1400. Bundle.entry:diagReport.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())) | ||||
| 1402. Bundle.entry:diagReport.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())) | ||||
| 1404. Bundle.entry:diagReport.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 | ||||
| 1406. Bundle.entry:advancedDirective | |||||
| Slice Name | advancedDirective | ||||
| Definition | 事前指示を記述して参照する。 | ||||
| Short | 事前指示を記述したConcentリソースを参照 | ||||
| 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())) | ||||
| 1408. Bundle.entry:advancedDirective.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 | ||||
| 1410. Bundle.entry:advancedDirective.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()) | ||||
| 1412. Bundle.entry:advancedDirective.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()) | ||||
| 1414. Bundle.entry:advancedDirective.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())) | ||||
| 1416. Bundle.entry:advancedDirective.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())) | ||||
| 1418. Bundle.entry:advancedDirective.resource | |||||
| Definition | 特定の目的と期間のために、特定のポリシーコンテキスト内で特定のアクションを実行できるように、特定された受信者または受信者の役割を許可または否定する医療消費者の選択の記録。 / A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time. | ||||
| Short | 特定の目的と期間のためにアクションを実行するための受信者または役割を許可または拒否するヘルスケア消費者の選択 / A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | ||||
| Comments | 大まかに、患者には3つの重要な同意領域があります。情報の共有に関する同意(別名プライバシー同意指令 - 情報を収集、使用、または開示する許可)、特定の治療または治療の種類、および一般的な事前ケア指令の同意。 / Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives. | ||||
| Control | 0..1 | ||||
| Type | Consent(JP_Consent) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 1420. Bundle.entry:advancedDirective.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())) | ||||
| 1422. Bundle.entry:advancedDirective.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 | ||||
| 1424. Bundle.entry:advancedDirective.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()) | ||||
| 1426. Bundle.entry:advancedDirective.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()) | ||||
| 1428. Bundle.entry:advancedDirective.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())) | ||||
| 1430. Bundle.entry:advancedDirective.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())) | ||||
| 1432. Bundle.entry:advancedDirective.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())) | ||||
| 1434. Bundle.entry:advancedDirective.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 | ||||
| 1436. Bundle.entry:advancedDirective.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()) | ||||
| 1438. Bundle.entry:advancedDirective.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()) | ||||
| 1440. Bundle.entry:advancedDirective.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())) | ||||
| 1442. Bundle.entry:advancedDirective.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())) | ||||
| 1444. Bundle.entry:advancedDirective.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())) | ||||
| 1446. Bundle.entry:advancedDirective.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())) | ||||
| 1448. Bundle.entry:advancedDirective.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())) | ||||
| 1450. Bundle.entry:advancedDirective.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())) | ||||
| 1452. Bundle.entry:advancedDirective.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())) | ||||
| 1454. Bundle.entry:advancedDirective.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 | ||||
| 1456. Bundle.entry:advancedDirective.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()) | ||||
| 1458. Bundle.entry:advancedDirective.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()) | ||||
| 1460. Bundle.entry:advancedDirective.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())) | ||||
| 1462. Bundle.entry:advancedDirective.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())) | ||||
| 1464. Bundle.entry:advancedDirective.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())) | ||||
| 1466. Bundle.entry:advancedDirective.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())) | ||||
| 1468. Bundle.entry:advancedDirective.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 | ||||
| 1470. Bundle.entry:researchSubject | |||||
| Slice Name | researchSubject | ||||
| Definition | 臨床研究参加者情報を記述して参照する。 | ||||
| Short | 臨床研究参加情報者を記述したResearchSubject_リソースを参照 | ||||
| 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())) | ||||
| 1472. Bundle.entry:researchSubject.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 | ||||
| 1474. Bundle.entry:researchSubject.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()) | ||||
| 1476. Bundle.entry:researchSubject.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()) | ||||
| 1478. Bundle.entry:researchSubject.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())) | ||||
| 1480. Bundle.entry:researchSubject.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())) | ||||
| 1482. Bundle.entry:researchSubject.resource | |||||
| Definition | 研究における運用上および/または管理上の関心の主要な単位である物理的エンティティ。 / A physical entity which is the primary unit of operational and/or administrative interest in a study. | ||||
| Short | 研究に関心のある主要な単位である物理的実体 / Physical entity which is the primary unit of interest in the study | ||||
| Comments | 公衆衛生研究を網羅することを確認する必要があります。 / Need to make sure we encompass public health studies. | ||||
| Control | 0..1 | ||||
| Type | ResearchSubject(JP_ResearchSubject) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | Study Subject | ||||
| 1484. Bundle.entry:researchSubject.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())) | ||||
| 1486. Bundle.entry:researchSubject.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 | ||||
| 1488. Bundle.entry:researchSubject.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()) | ||||
| 1490. Bundle.entry:researchSubject.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()) | ||||
| 1492. Bundle.entry:researchSubject.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())) | ||||
| 1494. Bundle.entry:researchSubject.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())) | ||||
| 1496. Bundle.entry:researchSubject.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())) | ||||
| 1498. Bundle.entry:researchSubject.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 | ||||
| 1500. Bundle.entry:researchSubject.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()) | ||||
| 1502. Bundle.entry:researchSubject.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()) | ||||
| 1504. Bundle.entry:researchSubject.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())) | ||||
| 1506. Bundle.entry:researchSubject.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())) | ||||
| 1508. Bundle.entry:researchSubject.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())) | ||||
| 1510. Bundle.entry:researchSubject.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())) | ||||
| 1512. Bundle.entry:researchSubject.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())) | ||||
| 1514. Bundle.entry:researchSubject.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())) | ||||
| 1516. Bundle.entry:researchSubject.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())) | ||||
| 1518. Bundle.entry:researchSubject.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 | ||||
| 1520. Bundle.entry:researchSubject.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()) | ||||
| 1522. Bundle.entry:researchSubject.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()) | ||||
| 1524. Bundle.entry:researchSubject.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())) | ||||
| 1526. Bundle.entry:researchSubject.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())) | ||||
| 1528. Bundle.entry:researchSubject.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())) | ||||
| 1530. Bundle.entry:researchSubject.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())) | ||||
| 1532. Bundle.entry:researchSubject.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 | ||||
| 1534. Bundle.entry:researchStudy | |||||
| Slice Name | researchStudy | ||||
| Definition | 臨床研究情報を記述して参照する。 | ||||
| Short | 臨床研究情報を記述したResearchStudyリソースを参照 | ||||
| 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())) | ||||
| 1536. Bundle.entry:researchStudy.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 | ||||
| 1538. Bundle.entry:researchStudy.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()) | ||||
| 1540. Bundle.entry:researchStudy.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()) | ||||
| 1542. Bundle.entry:researchStudy.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())) | ||||
| 1544. Bundle.entry:researchStudy.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())) | ||||
| 1546. Bundle.entry:researchStudy.resource | |||||
| Definition | 研究者または組織が、医療関連の知識の分野を増やすことを目的とした一連のステップを計画し、実行するプロセス。これには、安全性、有効性、比較有効性、および薬、デバイス、治療、その他の介入および調査手法に関するその他の情報の研究が含まれます。研究の研究には、人間または動物の被験者に関する情報の収集が含まれます。 / A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects. | ||||
| Short | 医療関連の患者に依存しない知識を高めるための調査 / Investigation to increase healthcare-related patient-independent knowledge | ||||
| Comments | 公衆衛生研究を網羅することを確認する必要があります。 / Need to make sure we encompass public health studies. | ||||
| Control | 0..1 | ||||
| Type | ResearchStudy(JP_ResearchStudy) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | Clinical Trial, Study | ||||
| 1548. Bundle.entry:researchStudy.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())) | ||||
| 1550. Bundle.entry:researchStudy.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 | ||||
| 1552. Bundle.entry:researchStudy.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()) | ||||
| 1554. Bundle.entry:researchStudy.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()) | ||||
| 1556. Bundle.entry:researchStudy.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())) | ||||
| 1558. Bundle.entry:researchStudy.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())) | ||||
| 1560. Bundle.entry:researchStudy.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())) | ||||
| 1562. Bundle.entry:researchStudy.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 | ||||
| 1564. Bundle.entry:researchStudy.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()) | ||||
| 1566. Bundle.entry:researchStudy.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()) | ||||
| 1568. Bundle.entry:researchStudy.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())) | ||||
| 1570. Bundle.entry:researchStudy.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())) | ||||
| 1572. Bundle.entry:researchStudy.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())) | ||||
| 1574. Bundle.entry:researchStudy.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())) | ||||
| 1576. Bundle.entry:researchStudy.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())) | ||||
| 1578. Bundle.entry:researchStudy.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())) | ||||
| 1580. Bundle.entry:researchStudy.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())) | ||||
| 1582. Bundle.entry:researchStudy.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 | ||||
| 1584. Bundle.entry:researchStudy.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()) | ||||
| 1586. Bundle.entry:researchStudy.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()) | ||||
| 1588. Bundle.entry:researchStudy.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())) | ||||
| 1590. Bundle.entry:researchStudy.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())) | ||||
| 1592. Bundle.entry:researchStudy.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())) | ||||
| 1594. Bundle.entry:researchStudy.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())) | ||||
| 1596. Bundle.entry:researchStudy.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 | ||||
| 1598. Bundle.entry:relatedPerson | |||||
| Slice Name | relatedPerson | ||||
| Definition | 親族情報を記述して参照する。 | ||||
| Short | 親族情報を記述したRelatedPersonリソースを参照 | ||||
| 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())) | ||||
| 1600. Bundle.entry:relatedPerson.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 1602. Bundle.entry:relatedPerson.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1604. 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()) | ||||
| 1606. Bundle.entry:relatedPerson.link | |||||
| Definition | A series of links that provide context to this entry. | ||||
| Short | Links related to this entry | ||||
| Control | 0..* | ||||
| Type | Seettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1608. Bundle.entry:relatedPerson.fullUrl | |||||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||||
| Control | 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())) | ||||
| 1610. Bundle.entry:relatedPerson.resource | |||||
| Definition | 患者のケアに関与しているが、ヘルスケアの標的ではなく、ケアプロセスに正式な責任を負う人に関する情報。 / Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. | ||||
| Short | 患者に関連しているが、ケアの直接的な標的ではない人 / A person that is related to a patient, but who is not a direct target of care | ||||
| Control | 0..1 | ||||
| Type | RelatedPerson(JP_RelatedPerson) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 1612. Bundle.entry:relatedPerson.search | |||||
| Definition | Information about the search process that lead to the creation of this entry. | ||||
| Short | Search related information | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-2 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1614. Bundle.entry:relatedPerson.search.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 1616. Bundle.entry:relatedPerson.search.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1618. Bundle.entry:relatedPerson.search.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1620. Bundle.entry:relatedPerson.search.mode | |||||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Short | match | include | outcome - why this is in the result set | ||||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from SearchEntryMode (required to http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1)Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1622. Bundle.entry:relatedPerson.search.score | |||||
| Definition | When searching, the server's search ranking score for the entry. | ||||
| Short | Search ranking (between 0 and 1) | ||||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1624. Bundle.entry:relatedPerson.request | |||||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||||
| Short | Additional execution information (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-3 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1626. Bundle.entry:relatedPerson.request.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 1628. Bundle.entry:relatedPerson.request.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1630. Bundle.entry:relatedPerson.request.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1632. Bundle.entry:relatedPerson.request.method | |||||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from HTTPVerb (required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1634. Bundle.entry:relatedPerson.request.url | |||||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||||
| Short | URL for HTTP equivalent of this entry | ||||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1636. Bundle.entry:relatedPerson.request.ifNoneMatch | |||||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1638. Bundle.entry:relatedPerson.request.ifModifiedSince | |||||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||||
| Short | For managing cache currency | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1640. Bundle.entry:relatedPerson.request.ifMatch | |||||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||||
| Short | For managing update contention | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1642. Bundle.entry:relatedPerson.request.ifNoneExist | |||||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||||
| Short | For conditional creates | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1644. Bundle.entry:relatedPerson.response | |||||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||||
| Short | Results of execution (transaction/batch/history) | ||||
| Control | 0..1 This element is affected by the following invariants: bdl-4 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1646. Bundle.entry:relatedPerson.response.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 1648. Bundle.entry:relatedPerson.response.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1650. Bundle.entry:relatedPerson.response.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 1652. Bundle.entry:relatedPerson.response.status | |||||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||||
| Short | Status response code (text optional) | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1654. Bundle.entry:relatedPerson.response.location | |||||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||||
| Short | The location (if the operation returns a location) | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1656. Bundle.entry:relatedPerson.response.etag | |||||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||||
| Short | The Etag for the resource (if relevant) | ||||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1658. Bundle.entry:relatedPerson.response.lastModified | |||||
| Definition | The date/time that the resource was modified on the server. | ||||
| Short | Server's date time modified | ||||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 1660. Bundle.entry:relatedPerson.response.outcome | |||||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||||
| Control | 0..1 | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 1662. Bundle.entry:bundleData | |||||
| Slice Name | bundleData | ||||
| Definition | 各種のBudle文書を参照する。 | ||||
| Short | 各種のBudle文書 | ||||
| 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())) | ||||
| 1664. Bundle.entry:bundleData.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 | ||||
| 1666. Bundle.entry:bundleData.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()) | ||||
| 1668. Bundle.entry:bundleData.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()) | ||||
| 1670. Bundle.entry:bundleData.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())) | ||||
| 1672. Bundle.entry:bundleData.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())) | ||||
| 1674. Bundle.entry:bundleData.resource | |||||
| Definition | A container for a collection of resources. | ||||
| Short | Contains a collection of resources | ||||
| Control | 0..1 | ||||
| Type | Bundle(JP_Bundle) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 1676. Bundle.entry:bundleData.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())) | ||||
| 1678. Bundle.entry:bundleData.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 | ||||
| 1680. Bundle.entry:bundleData.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()) | ||||
| 1682. Bundle.entry:bundleData.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()) | ||||
| 1684. Bundle.entry:bundleData.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())) | ||||
| 1686. Bundle.entry:bundleData.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())) | ||||
| 1688. Bundle.entry:bundleData.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())) | ||||
| 1690. Bundle.entry:bundleData.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 | ||||
| 1692. Bundle.entry:bundleData.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()) | ||||
| 1694. Bundle.entry:bundleData.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()) | ||||
| 1696. Bundle.entry:bundleData.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())) | ||||
| 1698. Bundle.entry:bundleData.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())) | ||||
| 1700. Bundle.entry:bundleData.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())) | ||||
| 1702. Bundle.entry:bundleData.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())) | ||||
| 1704. Bundle.entry:bundleData.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())) | ||||
| 1706. Bundle.entry:bundleData.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())) | ||||
| 1708. Bundle.entry:bundleData.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())) | ||||
| 1710. Bundle.entry:bundleData.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 | ||||
| 1712. Bundle.entry:bundleData.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()) | ||||
| 1714. Bundle.entry:bundleData.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()) | ||||
| 1716. Bundle.entry:bundleData.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())) | ||||
| 1718. Bundle.entry:bundleData.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())) | ||||
| 1720. Bundle.entry:bundleData.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())) | ||||
| 1722. Bundle.entry:bundleData.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())) | ||||
| 1724. Bundle.entry:bundleData.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 | ||||
| 1726. Bundle.signature | |||||
| Definition | Digital Signature - base64 encoded. XML-DSig or a JWT. | ||||
| Short | Digital Signature | ||||
| Comments | The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific. | ||||
| Control | 0..1 | ||||
| Type | Signature | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||