Period Tracking Bundle

DefinitionA stable identifier for this exported collection when the producing app has one. It is not required for anonymous or one-off shares.

DefinitionPeriod Tracking exports are self-contained collection Bundles, not transaction, batch, or document Bundles.

DefinitionThe time the producing system assembled this export Bundle.

DefinitionThe Bundle entries carrying the period-tracking Observations and any optional Patient or Device resources included by the producer.

CommentThe Bundle must contain at least one Layer 0 menstrual bleeding Observation. Other resources are included only when they support the selected share.

DefinitionA fullUrl that allows entries in this self-contained Bundle to reference each other consistently. Producers that have no other persistent identity for an entry may use a urn:uuid value (for example, urn:uuid:6c2d3e4f-...).

CommentEach entry SHALL carry a fullUrl. A urn:uuid value is an acceptable fullUrl for self-contained collection Bundles.

DefinitionThe FHIR resource included in this Bundle entry.

DefinitionA stable identifier for this exported collection when the producing app has one. It is not required for anonymous or one-off shares.

DefinitionPeriod Tracking exports are self-contained collection Bundles, not transaction, batch, or document Bundles.

DefinitionThe time the producing system assembled this export Bundle.

DefinitionThe Bundle entries carrying the period-tracking Observations and any optional Patient or Device resources included by the producer.

CommentThe Bundle must contain at least one Layer 0 menstrual bleeding Observation. Other resources are included only when they support the selected share.

DefinitionA fullUrl that allows entries in this self-contained Bundle to reference each other consistently. Producers that have no other persistent identity for an entry may use a urn:uuid value (for example, urn:uuid:6c2d3e4f-...).

CommentEach entry SHALL carry a fullUrl. A urn:uuid value is an acceptable fullUrl for self-contained collection Bundles.

DefinitionThe FHIR resource included in this Bundle entry.

DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

CommentThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.

DefinitionThe 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.

DefinitionA 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.

CommentAsserting 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.

DefinitionThe base language in which the resource is written.

CommentLanguage 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).

DefinitionA stable identifier for this exported collection when the producing app has one. It is not required for anonymous or one-off shares.

CommentPersistent 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.

DefinitionPeriod Tracking exports are self-contained collection Bundles, not transaction, batch, or document Bundles.

CommentIt'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.

DefinitionThe time the producing system assembled this export Bundle.

CommentFor 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: * document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time * message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message * history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates * searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query * transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning 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.

DefinitionIf 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.

CommentOnly 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.

DefinitionA series of links that provide context to this bundle.

CommentBoth Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)). Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http://hl7.org/fhir/R4/http.html#read) directly. This specification defines some specific uses of Bundle.link for [searching](http://hl7.org/fhir/R4/search.html#conformance) and [paging](http://hl7.org/fhir/R4/http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.

DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

CommentThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

CommentThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DefinitionA name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).

DefinitionThe reference details for the link.

DefinitionThe Bundle entries carrying the period-tracking Observations and any optional Patient or Device resources included by the producer.

CommentThe Bundle must contain at least one Layer 0 menstrual bleeding Observation. Other resources are included only when they support the selected share.

DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

CommentThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

CommentThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DefinitionA series of links that provide context to this entry.

DefinitionA fullUrl that allows entries in this self-contained Bundle to reference each other consistently. Producers that have no other persistent identity for an entry may use a urn:uuid value (for example, urn:uuid:6c2d3e4f-...).

CommentEach entry SHALL carry a fullUrl. A urn:uuid value is an acceptable fullUrl for self-contained collection Bundles.

DefinitionThe FHIR resource included in this Bundle entry.

DefinitionInformation about the search process that lead to the creation of this entry.

DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

CommentThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

CommentThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DefinitionWhy 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.

CommentThere 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.

DefinitionWhen searching, the server's search ranking score for the entry.

CommentServers 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](http://hl7.org/fhir/R4/patient-operation-match.html) for the EMPI search which relates to this element.

DefinitionAdditional 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.

DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

CommentThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

CommentThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DefinitionIn 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.

DefinitionThe URL for this entry, relative to the root (the address to which the request is posted).

CommentE.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]".

DefinitionIf the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http://hl7.org/fhir/R4/http.html#cread).

DefinitionOnly perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http://hl7.org/fhir/R4/http.html#cread).

DefinitionOnly perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http://hl7.org/fhir/R4/http.html#concurrency).

DefinitionInstruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http://hl7.org/fhir/R4/http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").

DefinitionIndicates 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.

DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

CommentThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

CommentThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DefinitionThe 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.

DefinitionThe location header created by processing this operation, populated if the operation returns a location.

DefinitionThe Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http://hl7.org/fhir/R4/http.html#versioning) and [Managing Resource Contention](http://hl7.org/fhir/R4/http.html#concurrency)).

CommentEtags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

DefinitionThe date/time that the resource was modified on the server.

CommentThis has to match the same time in the meta header (meta.lastUpdated) if a resource is included.

DefinitionAn OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

CommentFor 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.

DefinitionDigital Signature - base64 encoded. XML-DSig or a JWT.

CommentThe 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.