Page Status: draft updated 2025-11-04
Bundle - HVOOrganizationTransactionBundle
Page index
General information
A Bundle is a collection of resources. It can be used to return results in a search query or to perform an insert or update that requires multiple entries of resources.
Scope and Usage
This profile of Bundle is used in a request, filling the role of a transaction.
The transaction that can be used with this profiling of Bundle is that of updating or creating HVOOrganizations and HVOOrganizationalUnits. Using a transaction to handle these resources in one operation ensures that the relationships between them are created correctly, or maintained correctly when updating them.
Boundaries and Relationships
In order to perform read or search queries on these profiles, interact with them individually. See the supported queries on their respective pages.
Background and Context
Typically you want to create and update an organizational structure all at once - instead of creating or updating the organization and its units one by one. This makes it easier to build integrating systems with the catalog that perform continuous automatic updates to the hierarchy as well as front ends that offer a graphical interface to perform changes to the hierarchy and its members using the API.
Profile
| HVOOrganizationTransactionBundle (Bundle) | C | Bundle | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| identifier | Σ C | 0..1 | Identifier |
| type | S Σ C | 1..1 | codeBindingFixed Value |
| timestamp | Σ C | 0..1 | instant |
| total | Σ C | 0..1 | unsignedInt |
| link | Σ C | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| relation | Σ C | 1..1 | codeBinding |
| url | Σ C | 1..1 | uri |
| entry | S Σ C | 1..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| link | Σ | 0..* | see (link) |
| fullUrl | Σ C | 0..1 | uri |
| resource | S Σ C | 1..1 | HVOOrganization, HVOOrganizationalUnit |
| id | S Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | C | 0..1 | Narrative |
| contained | C | 0..* | Resource |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| identifier | Σ C | 0..* | Identifier |
| active | Σ ?! | 0..1 | boolean |
| type | Σ | 0..* | CodeableConcept |
| name | Σ C | 0..1 | string |
| alias | 0..* | string | |
| description | Σ | 0..1 | markdown |
| contact | C | 0..* | ExtendedContactDetail |
| partOf | Σ | 0..1 | Reference(Organization) |
| endpoint | 0..* | Reference(Endpoint) | |
| qualification | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| identifier | 0..* | Identifier | |
| code | 1..1 | CodeableConcept | |
| period | 0..1 | Period | |
| issuer | 0..1 | Reference(Organization) | |
| search | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| mode | Σ | 0..1 | codeBinding |
| score | Σ | 0..1 | decimal |
| request | S Σ C | 1..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| method | S Σ C | 1..1 | codeBinding |
| url | S Σ | 1..1 | uriFixed Value |
| ifNoneMatch | Σ | 0..1 | string |
| ifModifiedSince | Σ | 0..1 | instant |
| ifMatch | Σ | 0..1 | string |
| ifNoneExist | Σ | 0..1 | string |
| response | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| status | Σ | 1..1 | string |
| location | Σ | 0..1 | uri |
| etag | Σ | 0..1 | string |
| lastModified | Σ | 0..1 | instant |
| outcome | Σ | 0..1 | Resource |
| signature | Σ | 0..1 | Signature |
| issues | Σ C | 0..1 | OperationOutcome |
| Bundle | |
| Short | Contains a collection of resources |
| Definition | A container for a collection of resources. |
| Cardinality | 0..* |
| Constraints |
|
| Mappings |
|
| Bundle.id | |
| Short | Logical id of this artifact |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Cardinality | 0..1 |
| Type | id |
| Summary | True |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Bundle.meta | |
| Short | Metadata about the resource |
| 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. |
| Cardinality | 0..1 |
| Type | Meta |
| Summary | True |
| Constraints |
|
| Bundle.implicitRules | |
| Short | A set of rules under which this content was created |
| 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. |
| Cardinality | 0..1 |
| Type | uri |
| Modifier | True |
| Summary | True |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Constraints |
|
| Bundle.language | |
| Short | Language of the resource content |
| Definition | The base language in which the resource is written. |
| Cardinality | 0..1 |
| Type | code |
| Binding | IETF language tag for a human language |
| 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). |
| Constraints |
|
| Bundle.identifier | |
| Short | Persistent identifier for the bundle |
| Definition | A persistent identifier for the bundle that won't change as a bundle is copied from server to server. |
| Cardinality | 0..1 |
| Type | Identifier |
| Summary | True |
| Comments | Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique. |
| Conditions | The cardinality or value of this element may be affected by these constraints: bdl-9 |
| Constraints |
|
| Mappings |
|
| Bundle.type | |
| Short | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification |
| Definition | Indicates the purpose of this bundle - how it is intended to be used. |
| Cardinality | 1..1 |
| Type | code |
| Binding | Indicates the purpose of a bundle - how it is intended to be used. |
| Must Support | True |
| Summary | True |
| 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: bdl-1, bdl-2, bdl-3a, bdl-3b, bdl-3c, bdl-3d, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-17, bdl-18 |
| Constraints |
|
| Fixed Value | transaction |
| Mappings |
|
| Bundle.timestamp | |
| Short | When the bundle was assembled |
| Definition | The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. |
| Cardinality | 0..1 |
| Type | instant |
| Summary | True |
| 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: bdl-10 |
| Constraints |
|
| Mappings |
|
| Bundle.total | |
| Short | If search, the total number of matches |
| Definition | If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. |
| Cardinality | 0..1 |
| Type | unsignedInt |
| Summary | True |
| 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: bdl-1 |
| Constraints |
|
| Bundle.link | |
| Short | Links related to this Bundle |
| Definition | A series of links that provide context to this bundle. |
| Cardinality | 0..* |
| Type | BackboneElement |
| Summary | True |
| Comments | Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS). Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly. This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners. |
| Conditions | The cardinality or value of this element may be affected by these constraints: bdl-18 |
| Constraints |
|
| Bundle.link.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Bundle.link.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| Bundle.link.modifierExtension | |
| Short | Extensions that cannot be ignored even if unrecognized |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0..* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| Bundle.link.relation | |
| Short | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
| 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. |
| Cardinality | 1..1 |
| Type | code |
| Binding | |
| Summary | True |
| Conditions | The cardinality or value of this element may be affected by these constraints: bdl-18 |
| Constraints |
|
| Bundle.link.url | |
| Short | Reference details for the link |
| Definition | The reference details for the link. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Conditions | The cardinality or value of this element may be affected by these constraints: bdl-18 |
| Constraints |
|
| Bundle.entry | |
| Short | Entry in the bundle - will have a resource or information |
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
| Cardinality | 1..* |
| Type | BackboneElement |
| Must Support | True |
| Summary | True |
| Constraints |
|
| Bundle.entry.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Bundle.entry.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.modifierExtension | |
| Short | Extensions that cannot be ignored even if unrecognized |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0..* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.link | |
| Short | Links related to this entry |
| Definition | A series of links that provide context to this entry. |
| Cardinality | 0..* |
| Type | see (link) |
| Summary | True |
| Constraints |
|
| Bundle.entry.fullUrl | |
| Short | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| Definition | The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
|
| Cardinality | 0..1 |
| Type | uri |
| Summary | True |
| 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). |
| Conditions | The cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 |
| Constraints |
|
| Bundle.entry.resource | |
| Short | A resource in the bundle |
| Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning. |
| Cardinality | 1..1 |
| Type | HVOOrganization, HVOOrganizationalUnit |
| Must Support | True |
| Summary | True |
| Conditions | The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 |
| Bundle.entry.resource.id | |
| Short | UUID of Organization |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Cardinality | 0..1 |
| Type | id |
| Must Support | True |
| Summary | True |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Bundle.entry.resource.meta | |
| Short | Metadata about the resource |
| 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. |
| Cardinality | 0..1 |
| Type | Meta |
| Summary | True |
| Constraints |
|
| Bundle.entry.resource.implicitRules | |
| Short | A set of rules under which this content was created |
| 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. |
| Cardinality | 0..1 |
| Type | uri |
| Modifier | True |
| Summary | True |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Constraints |
|
| Bundle.entry.resource.language | |
| Short | Language of the resource content |
| Definition | The base language in which the resource is written. |
| Cardinality | 0..1 |
| Type | code |
| Binding | IETF language tag for a human language |
| 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). |
| Constraints |
|
| Bundle.entry.resource.text | |
| Short | Text summary of the resource, for human interpretation |
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| Cardinality | 0..1 |
| Type | Narrative |
| Alias | narrative, html, xhtml, display |
| Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-6 |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.contained | |
| Short | Contained, inline Resources |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Cardinality | 0..* |
| Type | Resource |
| Alias | inline resources, anonymous resources, contained resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 |
| Mappings |
|
| Bundle.entry.resource.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.modifierExtension | |
| Short | Extensions that cannot be ignored |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0..* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.identifier | |
| Short | Identifies this organization across multiple systems |
| Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. |
| Cardinality | 0..* |
| Type | Identifier |
| Summary | True |
| Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
| Conditions | The cardinality or value of this element may be affected by these constraints: org-1 |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.active | |
| Short | Whether the organization's record is still in active use |
| Definition | Whether the organization's record is still in active use. |
| Cardinality | 0..1 |
| Type | boolean |
| Modifier | True |
| Summary | True |
| Requirements | Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. |
| Comments | This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. |
| Meaning when missing | This resource is generally assumed to be active if no value is provided for the active element |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.type | |
| Short | Kind of organization |
| Definition | The kind(s) of organization that this is. |
| Cardinality | 0..* |
| Type | CodeableConcept |
| Binding | Used to categorize the organization. |
| Summary | True |
| Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. |
| Comments | Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.name | |
| Short | Name used for the organization |
| Definition | A name associated with the organization. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Requirements | Need to use the name as the label of the organization. |
| Comments | If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. |
| Conditions | The cardinality or value of this element may be affected by these constraints: org-1 |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.alias | |
| Short | A list of alternate names that the organization is known as, or was known as in the past |
| Definition | A list of alternate names that the organization is known as, or was known as in the past. |
| Cardinality | 0..* |
| Type | string |
| Requirements | Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. |
| Comments | There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.description | |
| Short | Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name |
| Definition | Description of the organization, which helps provide additional general context on the organization to ensure that the correct organization is selected. |
| Cardinality | 0..1 |
| Type | markdown |
| Summary | True |
| Requirements | Humans need additional information to verify a correct Organization has been selected. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.contact | |
| Short | Official contact details for the Organization |
| Definition | The contact details of communication devices available relevant to the specific Organization. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites. |
| Cardinality | 0..* |
| Type | ExtendedContactDetail |
| Requirements | Need to keep track of assigned contact points within bigger organization. |
| Comments | The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the Organization itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.partOf | |
| Short | The organization of which this organization forms a part |
| Definition | The organization of which this organization forms a part. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Summary | True |
| Requirements | Need to be able to track the hierarchy of organizations within an organization. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.endpoint | |
| Short | Technical endpoints providing access to services operated for the organization |
| Definition | Technical endpoints providing access to services operated for the organization. |
| Cardinality | 0..* |
| Type | Reference(Endpoint) |
| Requirements | Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.qualification | |
| Short | Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care |
| Definition | The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization. For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization. |
| Cardinality | 0..* |
| Type | BackboneElement |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.qualification.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Bundle.entry.resource.qualification.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.qualification.modifierExtension | |
| Short | Extensions that cannot be ignored even if unrecognized |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0..* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.qualification.identifier | |
| Short | An identifier for this qualification for the organization |
| Definition | An identifier allocated to this qualification for this organization. |
| Cardinality | 0..* |
| Type | Identifier |
| Requirements | Often, specific identities are assigned for the qualification by the assigning organization. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.qualification.code | |
| Short | Coded representation of the qualification |
| Definition | Coded representation of the qualification. |
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Binding | Specific qualification the organization has to provide a service. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.qualification.period | |
| Short | Period during which the qualification is valid |
| Definition | Period during which the qualification is valid. |
| Cardinality | 0..1 |
| Type | Period |
| Requirements | Qualifications are often for a limited period of time, and can be revoked. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.resource.qualification.issuer | |
| Short | Organization that regulates and issues the qualification |
| Definition | Organization that regulates and issues the qualification. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Constraints |
|
| Mappings |
|
| Bundle.entry.search | |
| Short | Search related information |
| Definition | Information about the search process that lead to the creation of this entry. |
| Cardinality | 0..1 |
| Type | BackboneElement |
| Summary | True |
| Conditions | The cardinality or value of this element may be affected by these constraints: bdl-2 |
| Constraints |
|
| Bundle.entry.search.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Bundle.entry.search.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.search.modifierExtension | |
| Short | Extensions that cannot be ignored even if unrecognized |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0..* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.search.mode | |
| Short | match | include - why this is in the result set |
| 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. |
| Cardinality | 0..1 |
| Type | code |
| Binding | 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. |
| Summary | True |
| 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. |
| Constraints |
|
| Bundle.entry.search.score | |
| Short | Search ranking (between 0 and 1) |
| Definition | When searching, the server's search ranking score for the entry. |
| Cardinality | 0..1 |
| Type | decimal |
| Summary | True |
| 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. |
| Constraints |
|
| Bundle.entry.request | |
| Short | Additional execution information (transaction/batch/history) |
| 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. |
| Cardinality | 1..1 |
| Type | BackboneElement |
| Must Support | True |
| Summary | True |
| Conditions | The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 |
| Constraints |
|
| Bundle.entry.request.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Bundle.entry.request.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.request.modifierExtension | |
| Short | Extensions that cannot be ignored even if unrecognized |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0..* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.request.method | |
| Short | PUT | POST | PATCH |
| 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. |
| Cardinality | 1..1 |
| Type | code |
| Binding | HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| Must Support | True |
| Summary | True |
| Conditions | The cardinality or value of this element may be affected by these constraints: bdl-3b, bdl-3c, bdl-14, bdl-15 |
| Constraints |
|
| Bundle.entry.request.url | |
| Short | URL for HTTP equivalent of this entry |
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). |
| Cardinality | 1..1 |
| Type | uri |
| Must Support | True |
| Summary | True |
| 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]". |
| Constraints |
|
| Fixed Value | Organization |
| Bundle.entry.request.ifNoneMatch | |
| Short | For managing cache validation |
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Constraints |
|
| Bundle.entry.request.ifModifiedSince | |
| Short | For managing cache currency |
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". |
| Cardinality | 0..1 |
| Type | instant |
| Summary | True |
| Constraints |
|
| Bundle.entry.request.ifMatch | |
| Short | For managing update contention |
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Constraints |
|
| Bundle.entry.request.ifNoneExist | |
| Short | For conditional creates |
| 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 "?"). |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Constraints |
|
| Bundle.entry.response | |
| Short | Results of execution (transaction/batch/history) |
| 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. |
| Cardinality | 0..1 |
| Type | BackboneElement |
| Summary | True |
| Conditions | The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 |
| Constraints |
|
| Bundle.entry.response.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Bundle.entry.response.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.response.modifierExtension | |
| Short | Extensions that cannot be ignored even if unrecognized |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0..* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| Bundle.entry.response.status | |
| Short | Status response code (text optional) |
| 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. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Constraints |
|
| Bundle.entry.response.location | |
| Short | The location (if the operation returns a location) |
| Definition | The location header created by processing this operation, populated if the operation returns a location. |
| Cardinality | 0..1 |
| Type | uri |
| Summary | True |
| Constraints |
|
| Bundle.entry.response.etag | |
| Short | The Etag for the resource (if relevant) |
| 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). |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. |
| Constraints |
|
| Bundle.entry.response.lastModified | |
| Short | Server's date time modified |
| Definition | The date/time that the resource was modified on the server. |
| Cardinality | 0..1 |
| Type | instant |
| Summary | True |
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. |
| Constraints |
|
| Bundle.entry.response.outcome | |
| Short | OperationOutcome with hints and warnings (for batch/transaction) |
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. |
| Cardinality | 0..1 |
| Type | Resource |
| Summary | True |
| 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. |
| Bundle.signature | |
| Short | Digital Signature |
| Definition | Digital Signature - base64 encoded. XML-DSig or a JWS. |
| Cardinality | 0..1 |
| Type | Signature |
| 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. |
| 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. |
| Constraints |
|
| Bundle.issues | |
| Short | Issues with the Bundle |
| Definition | Captures issues and warnings that relate to the construction of the Bundle and the content within it. |
| Cardinality | 0..1 |
| Type | OperationOutcome |
| Summary | True |
| Comments | Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle. |
| Conditions | The cardinality or value of this element may be affected by these constraints: bdl-16, bdl-17 |
Details
The must-support flag indicates that the element is expected in some use cases, and a missing flag that the element is never used.
The type element must be set to transaction. This makes sure that the server interprets the entries as being connected to each other.
The HVOOrganizationTransactionBundle must consist of at least one entry with a HVOOrganization or at least one entry with a HVOOrganizationalUnit. All resources must have the Organization.id element populated with a new unique UUID if the resource is being created or its existing UUID if it is being updated. To build up a hierarchy, use the Organization.partOf element to reference the id of the organization or organizational unit that is above a given member. Any entry that is not referenced to in this way and does not reference another entry in its partOf element will be ignored as it is interpreted as being outside the hierarchy.
For all resources that are being created, the request.method element of these entries must be set to POST. For all resources that are being updated, the request.method element of these entries must be set to PUT or PATCH.
Validation rules
See HVOOrganization and HVOOrganizationalUnit for the validation rules that apply for the entries in the Bundle.
Supported operations
HTTP methods
| Operation | Supported | Invocation | Comment |
|---|---|---|---|
| Search (GET, POST) | no | ||
| Insert (POST) | yes | POST [base]/ |
Is used for both creating and updating resources in the Bundle. Set the entry.request.method field to POST for each resource that is going to get created. |
| Update (PUT/PATCH) | no | POST is used for updating resources in the Bundle. Set the entry.request.method field to PUT or PATCH for each resource that is going to get updated. | |
| Delete (DEL) | no | ||
| Operation (GET, POST) | no |