Argo-Scheduling Implementation Guide Release 1.0.0

This page is part of the Argonaut Scheduling Implementation Guide (v1.0.0: Release) based on FHIR R3. This is the current published version. For a full list of available versions, see the Directory of published versions

SD.7 StructureDefinition-avail-bundle

The Argonaut Appointment Bundle profile sets the minimum expectations for the Bundle resource which is returned as a result of the $find operation and when fetching appointments.

Mandatory Data Elements

Each Bundle must have:

  1. a bundle type
  2. a total number of matches

The system Must Support if available:

  1. Appointment entries
  2. OperationOutcome entry

Additional Profile specific implementation guidance:

  • None

Examples

SD.7.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/avail-bundle

Published on Thu Jan 11 00:00:00 AEDT 2018 as a active by Argonaut Project.

This profile builds on Bundle


Summary

Mandatory: 2 elements (2 nested mandatory elements)
Must-Support: 11 elements
Fixed Value: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Bundle.entry is sliced based on the value of type:resource
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*Contains a collection of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... identifier Σ0..1IdentifierPersistent identifier for the bundle
... type SΣ1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required)
Fixed Value: searchset
... total SΣI1..1unsignedIntIf search, the total number of matches
... link ΣI0..*BackboneElementLinks related to this Bundle
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... entry SΣIBackboneElementEntry in the bundle - will have a resource, or information
Slice: Unordered, Open by type:resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... link Σ0..*Unknown reference to #Bundle.link
Links related to this entry
.... fullUrl Σ0..1uriAbsolute URL for resource (server address, or UUID/OID)
.... resource Σ0..1ResourceA resource in the bundle
.... search ΣI0..1BackboneElementSearch related information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
..... score Σ0..1decimalSearch ranking (between 0 and 1)
.... request ΣI0..1BackboneElementTransaction Related Information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... method Σ1..1codeGET | POST | PUT | DELETE
Binding: HTTPVerb (required)
..... url Σ1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch Σ0..1stringFor managing cache currency
..... ifModifiedSince Σ0..1instantFor managing update contention
..... ifMatch Σ0..1stringFor managing update contention
..... ifNoneExist Σ0..1stringFor conditional creates
.... response ΣI0..1BackboneElementTransaction Related Information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... status Σ1..1stringStatus response code (text optional)
..... location Σ0..1uriThe location, if the operation returns a location
..... etag Σ0..1stringThe etag for the resource (if relevant)
..... lastModified Σ0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... entry SΣI0..*BackboneElementEntry in the bundle - will have a resource, or information
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... link Σ0..*Unknown reference to #Bundle.link
Links related to this entry
.... fullUrl Σ0..1uriAbsolute URL for resource (server address, or UUID/OID)
.... resource SΣ0..1Argonaut_Appointment_ProfileA resource in the bundle
.... search SΣI0..1BackboneElementSearch related information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... mode SΣ1..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
Fixed Value: match
..... score Σ0..1decimalSearch ranking (between 0 and 1)
.... request ΣI0..1BackboneElementTransaction Related Information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... method Σ1..1codeGET | POST | PUT | DELETE
Binding: HTTPVerb (required)
..... url Σ1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch Σ0..1stringFor managing cache currency
..... ifModifiedSince Σ0..1instantFor managing update contention
..... ifMatch Σ0..1stringFor managing update contention
..... ifNoneExist Σ0..1stringFor conditional creates
.... response ΣI0..1BackboneElementTransaction Related Information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... status Σ1..1stringStatus response code (text optional)
..... location Σ0..1uriThe location, if the operation returns a location
..... etag Σ0..1stringThe etag for the resource (if relevant)
..... lastModified Σ0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... entry SΣI0..*BackboneElementEntry in the bundle - will have a resource, or information
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... link Σ0..*Unknown reference to #Bundle.link
Links related to this entry
.... fullUrl Σ0..1uriAbsolute URL for resource (server address, or UUID/OID)
.... resource SΣ0..1OperationOutcomeA resource in the bundle
.... search SΣI0..1BackboneElementSearch related information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... mode SΣ1..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
Fixed Value: outcome
..... score Σ0..1decimalSearch ranking (between 0 and 1)
.... request ΣI0..1BackboneElementTransaction Related Information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... method Σ1..1codeGET | POST | PUT | DELETE
Binding: HTTPVerb (required)
..... url Σ1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch Σ0..1stringFor managing cache currency
..... ifModifiedSince Σ0..1instantFor managing update contention
..... ifMatch Σ0..1stringFor managing update contention
..... ifNoneExist Σ0..1stringFor conditional creates
.... response ΣI0..1BackboneElementTransaction Related Information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... status Σ1..1stringStatus response code (text optional)
..... location Σ0..1uriThe location, if the operation returns a location
..... etag Σ0..1stringThe etag for the resource (if relevant)
..... lastModified Σ0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

Summary

Mandatory: 2 elements (2 nested mandatory elements)
Must-Support: 11 elements
Fixed Value: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Bundle.entry is sliced based on the value of type:resource

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*Contains a collection of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... identifier Σ0..1IdentifierPersistent identifier for the bundle
... type SΣ1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required)
Fixed Value: searchset
... total SΣI1..1unsignedIntIf search, the total number of matches
... link ΣI0..*BackboneElementLinks related to this Bundle
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... entry SΣIBackboneElementEntry in the bundle - will have a resource, or information
Slice: Unordered, Open by type:resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... link Σ0..*Unknown reference to #Bundle.link
Links related to this entry
.... fullUrl Σ0..1uriAbsolute URL for resource (server address, or UUID/OID)
.... resource Σ0..1ResourceA resource in the bundle
.... search ΣI0..1BackboneElementSearch related information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
..... score Σ0..1decimalSearch ranking (between 0 and 1)
.... request ΣI0..1BackboneElementTransaction Related Information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... method Σ1..1codeGET | POST | PUT | DELETE
Binding: HTTPVerb (required)
..... url Σ1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch Σ0..1stringFor managing cache currency
..... ifModifiedSince Σ0..1instantFor managing update contention
..... ifMatch Σ0..1stringFor managing update contention
..... ifNoneExist Σ0..1stringFor conditional creates
.... response ΣI0..1BackboneElementTransaction Related Information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... status Σ1..1stringStatus response code (text optional)
..... location Σ0..1uriThe location, if the operation returns a location
..... etag Σ0..1stringThe etag for the resource (if relevant)
..... lastModified Σ0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... entry SΣI0..*BackboneElementEntry in the bundle - will have a resource, or information
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... link Σ0..*Unknown reference to #Bundle.link
Links related to this entry
.... fullUrl Σ0..1uriAbsolute URL for resource (server address, or UUID/OID)
.... resource SΣ0..1Argonaut_Appointment_ProfileA resource in the bundle
.... search SΣI0..1BackboneElementSearch related information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... mode SΣ1..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
Fixed Value: match
..... score Σ0..1decimalSearch ranking (between 0 and 1)
.... request ΣI0..1BackboneElementTransaction Related Information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... method Σ1..1codeGET | POST | PUT | DELETE
Binding: HTTPVerb (required)
..... url Σ1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch Σ0..1stringFor managing cache currency
..... ifModifiedSince Σ0..1instantFor managing update contention
..... ifMatch Σ0..1stringFor managing update contention
..... ifNoneExist Σ0..1stringFor conditional creates
.... response ΣI0..1BackboneElementTransaction Related Information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... status Σ1..1stringStatus response code (text optional)
..... location Σ0..1uriThe location, if the operation returns a location
..... etag Σ0..1stringThe etag for the resource (if relevant)
..... lastModified Σ0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... entry SΣI0..*BackboneElementEntry in the bundle - will have a resource, or information
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... link Σ0..*Unknown reference to #Bundle.link
Links related to this entry
.... fullUrl Σ0..1uriAbsolute URL for resource (server address, or UUID/OID)
.... resource SΣ0..1OperationOutcomeA resource in the bundle
.... search SΣI0..1BackboneElementSearch related information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... mode SΣ1..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
Fixed Value: outcome
..... score Σ0..1decimalSearch ranking (between 0 and 1)
.... request ΣI0..1BackboneElementTransaction Related Information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... method Σ1..1codeGET | POST | PUT | DELETE
Binding: HTTPVerb (required)
..... url Σ1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch Σ0..1stringFor managing cache currency
..... ifModifiedSince Σ0..1instantFor managing update contention
..... ifMatch Σ0..1stringFor managing update contention
..... ifNoneExist Σ0..1stringFor conditional creates
.... response ΣI0..1BackboneElementTransaction Related Information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... status Σ1..1stringStatus response code (text optional)
..... location Σ0..1uriThe location, if the operation returns a location
..... etag Σ0..1stringThe etag for the resource (if relevant)
..... lastModified Σ0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

SD.7.2 Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

Patient based Scheduling:

Provider based Scheduling: