0.1.0 - ci-build

SENAITEFHIRImplementationGuide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Senaite Service Request Bundle

Official URL: https://fhir.senaite.org/StructureDefinition/SenaiteRequestBundle Version: 0.1.0
Draft as of 2026-11-05 Computable Name: SenaiteRequestBundle

A transaction Bundle used to submit a laboratory service request to SENAITE. The ServiceRequest is the backbone of the Bundle.

Patient, Practitioner and Organization entries are 0..1. Include an entry when the resource may not yet exist on the server — the server creates it and assigns a logical id, or matches an existing one if request.ifNoneExist is supplied. Omit the entry when the resource is already known, and reference it by logical id (e.g. Organization/{id}) from the ServiceRequest. Every request must still identify its Client via extension[SenaiteClient], whether by urn:uuid or logical id.

ServiceRequest and Specimen are always created and always present, and a Bundle carries exactly one of each: one request is one sample. An order spanning several sample types (tubes) is submitted as one Bundle per tube, each ServiceRequest carrying the same requisition. See multi-tube orders in lab-request-and-results.html.

Identifiers on create. Patient, Practitioner, Organization and Specimen each carry a paired internal/external identifier. The internal identifier (use = usual) is generated by SENAITE and must not appear on any entry in this Bundle — no-internal-id-on-create rejects it. The external identifier (use = secondary) is consumer-owned and may be supplied. The ServiceRequest carries no identifier; its only identifier is the optional requisition, which groups the Bundles of one multi-tube order. See identifiers.html#general-pattern and identifiers.html#sample-group-id.

Barcode on create. The Specimen's barcode label (SenaiteSpecimenBarcode) is generated by SENAITE and must not appear on the Specimen entry — no-barcode-on-create rejects it. It is returned on the Specimen entry of the SenaiteBundleResponse.

ifNoneExist. Where supplied, it must take the form identifier=|. Either identifier may be used as the key: the external identifier the consumer already owns, or the internal identifier SENAITE returned from an earlier order. The system is mandatory in both cases — the identifier search parameter matches on system and value and ignores Identifier.use, so a bare value would match across every consumer's namespace and across SENAITE's own internal one. Supplying the internal identifier as an ifNoneExist key is not the same as supplying it in the resource body, which remains prohibited.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d
Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.type This element is included in summaries. C 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: transaction (no extensions allowed)
Bundle.Slices for entry This element is included in summaries. C 2..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.fullUrl This element is included in summaries. C 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Bundle.Slices for entry.entry:All Slices.resource This element is included in summaries. C 0..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:All Slices.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Bundle.Slices for entry.entry:All Slices.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:All Slices.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:serviceRequest This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:serviceRequest.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:serviceRequest.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:serviceRequest.resource 1..1 SenaiteServiceRequest Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A request for a service to be performed
Bundle.Slices for entry.entry:serviceRequest.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:serviceRequest.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:serviceRequest.resource.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.Slices for extension Content/Rules for all slices
Bundle.Slices for entry.entry:serviceRequest.resource.Slices for extension.extension:client 1..1 Reference(SenaiteOrganization) The submitting client organisation
URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient
Bundle.Slices for entry.entry:serviceRequest.resource.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | entered-in-error
Binding: RequestStatus (required): The status of a service order.
Bundle.Slices for entry.entry:serviceRequest.resource.intent This element is a modifier element. This element is included in summaries. 1..1 code order | reflex-order
Binding: RequestIntent (required): The kind of service request.
Fixed Value: order (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.category This element is included in summaries. 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (required): Classification of the requested service.
Bundle.Slices for entry.entry:serviceRequest.resource.category.text This element is included in summaries. 0..1 string Plain text representation of the concept
Fixed Value: Laboratory procedure (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.code This element is included in summaries. C 1..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
Binding: http://loinc.org (preferred): For laboratory codes
Bundle.Slices for entry.entry:serviceRequest.resource.code.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.subject This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
Bundle.Slices for entry.entry:serviceRequest.resource.subject.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Constraints: subject-identified
Bundle.Slices for entry.entry:serviceRequest.resource.specimen This element is included in summaries. 1..1 Reference(Specimen) Procedure Samples
Bundle.Slices for entry.entry:serviceRequest.resource.specimen.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Bundle.Slices for entry.entry:serviceRequest.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:serviceRequest.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:serviceRequest.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.request.url This element is included in summaries. 1..1 uri "ServiceRequest"
Bundle.Slices for entry.entry:patient This element is included in summaries. C 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:patient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:patient.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:patient.resource C 1..1 SenaitePatient Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Information about an individual or animal receiving health care services
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:patient.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:patient.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:patient.resource.Slices for extension Content/Rules for all slices
Bundle.Slices for entry.entry:patient.resource.Slices for extension.extension:estimatedDateBirth 0..1 boolean If the date of birth was not known precisely
URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth
Bundle.Slices for entry.entry:patient.resource.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:patient.resource.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:use
Bundle.Slices for entry.entry:patient.resource.Slices for identifier Content/Rules for all slices
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Patient ID — server-assigned, do not include on create
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Internal Patient ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/patient-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE patient identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn This element is included in summaries. 0..1 Identifier External Patient ID from the consumer's system — may be supplied on create
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.system This element is included in summaries. 1..1 uri External Patient ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/patient-mrn
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.value This element is included in summaries. C 1..1 string External patient identifier, typically an MRN — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:patient.resource.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Bundle.Slices for entry.entry:patient.resource.name This element is included in summaries. 1..* HumanName A name associated with the patient
Bundle.Slices for entry.entry:patient.resource.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Bundle.Slices for entry.entry:patient.resource.gender This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Bundle.Slices for entry.entry:patient.resource.birthDate This element is included in summaries. 1..1 date The date of birth for the individual
Bundle.Slices for entry.entry:patient.resource.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 dateTime Indicates if the individual is deceased or not
Bundle.Slices for entry.entry:patient.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:patient.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:patient.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:patient.request.url This element is included in summaries. 1..1 uri "Patient"
Bundle.Slices for entry.entry:patient.request.ifNoneExist This element is included in summaries. C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.Slices for entry.entry:practitioner This element is included in summaries. C 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:practitioner.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:practitioner.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:practitioner.resource C 1..1 SenaitePractitioner Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:practitioner.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:practitioner.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for the person as this agent
Slice: Unordered, Closed by value:use
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier Content/Rules for all slices
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Practitioner ID — server-assigned, do not include on create
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Internal Practitioner ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/practitioner-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE practitioner identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId This element is included in summaries. 0..1 Identifier External Practitioner ID from the consumer's system — may be supplied on create
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.system This element is included in summaries. 1..1 uri External Practitioner ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/practitioner-external-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.value This element is included in summaries. C 1..1 string External practitioner identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:practitioner.resource.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this practitioner's record is in active use
Bundle.Slices for entry.entry:practitioner.resource.name This element is included in summaries. 1..1 HumanName The name(s) associated with the practitioner
Bundle.Slices for entry.entry:practitioner.resource.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Bundle.Slices for entry.entry:practitioner.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:practitioner.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:practitioner.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:practitioner.request.url This element is included in summaries. 1..1 uri "Practitioner"
Bundle.Slices for entry.entry:practitioner.request.ifNoneExist This element is included in summaries. C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.Slices for entry.entry:specimen This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:specimen.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:specimen.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:specimen.resource C 1..1 SenaiteSpecimen Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Sample for analysis
Constraints: no-internal-id-on-create, no-barcode-on-create
Bundle.Slices for entry.entry:specimen.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:specimen.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:specimen.resource.Slices for extension Content/Rules for all slices
Bundle.Slices for entry.entry:specimen.resource.Slices for extension.extension:barcode 0..1 Attachment Barcode label (base64 PDF or image) — SHALL be present when returned by SENAITE; SHALL NOT be supplied on create
URL: https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier This element is included in summaries. 0..* Identifier External Identifier
Slice: Unordered, Closed by value:use
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier Content/Rules for all slices
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Sample ID — matches the DiagnosticReport usual identifier
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed)
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE sample identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId This element is included in summaries. 0..1 Identifier External Client Sample ID assigned by the consumer's system — may be supplied on create
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.system This element is included in summaries. 1..1 uri Client Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/client-sample-id (no extensions allowed)
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.value This element is included in summaries. C 1..1 string Client Sample ID — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:specimen.resource.status This element is a modifier element. This element is included in summaries. 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
Bundle.Slices for entry.entry:specimen.resource.type This element is included in summaries. 1..1 CodeableConcept Kind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.
Bundle.Slices for entry.entry:specimen.resource.type.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:specimen.resource.type.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
Binding: http://snomed.info/sct (preferred)
Bundle.Slices for entry.entry:specimen.resource.type.coding.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:specimen.resource.collection 1..1 BackboneElement Collection details
Bundle.Slices for entry.entry:specimen.resource.collection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:specimen.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:specimen.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:specimen.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:specimen.request.url This element is included in summaries. 1..1 uri "Specimen"
Bundle.Slices for entry.entry:organization This element is included in summaries. C 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:organization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:organization.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:organization.resource C 1..1 SenaiteOrganization Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A grouping of people or organizations with a common purpose
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:organization.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:organization.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:organization.resource.Slices for identifier This element is included in summaries. C 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Closed by value:use
Bundle.Slices for entry.entry:organization.resource.Slices for identifier Content/Rules for all slices
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId This element is included in summaries. C 0..1 Identifier Internal SENAITE Client ID — server-assigned, do not include on create
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Internal Organization ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/organization-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE client identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId This element is included in summaries. C 0..1 Identifier External Organization ID from the consumer's system — may be supplied on create
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.system This element is included in summaries. 1..1 uri External Organization ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/organization-external-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.value This element is included in summaries. C 1..1 string External organisation identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:organization.resource.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether the organization's record is still in active use
Bundle.Slices for entry.entry:organization.resource.name This element is included in summaries. C 1..1 string Name used for the organization
Bundle.Slices for entry.entry:organization.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:organization.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:organization.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:organization.request.url This element is included in summaries. 1..1 uri "Organization"
Bundle.Slices for entry.entry:organization.request.ifNoneExist This element is included in summaries. C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.issues This element is included in summaries. C 0..1 OperationOutcome(5.0.0) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Issues with the Bundle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.type Base required Bundle Type 📍5.0.0 FHIR Std.
Bundle.link.relation Base required Link Relation Types 📍5.0.0 FHIR Std.
Bundle.entry.request.​method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.status Base required RequestStatus 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.intent Base required RequestIntent 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.category Base required Service Request Category Codes 📦5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.code Base preferred http://loinc.org Not State Unknown
Bundle.entry:serviceRequest.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.identifier:mrn.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.name.use Base required NameUse 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.link.type Base required Link Type 📍5.0.0 FHIR Std.
Bundle.entry:patient.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.identifier:externalId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.name.use Base required NameUse 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.qualification.​code Base example hl7VS-degreeLicenseCertificate 📦3.0.0 THO v7.5
Bundle.entry:practitioner.​resource.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.identifier:clientSampleId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.status Base required Specimen Status 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.type Base example hl7VS-specimenType 📦3.0.0 THO v7.5
Bundle.entry:specimen.​resource.type.coding Base preferred http://snomed.info/sct Not State Unknown
Bundle.entry:specimen.​resource.feature.type Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:organization.​resource.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:organization.​resource.identifier:externalId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:organization.​resource.qualification.​code Base example Not State Unknown
Bundle.entry:organization.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search (type = 'searchset') or entry.search.empty()
bdl-5 error Bundle.entry, Bundle.entry:serviceRequest, Bundle.entry:patient, Bundle.entry:practitioner, Bundle.entry:specimen, Bundle.entry:organization must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
bdl-8 error Bundle.entry, Bundle.entry:serviceRequest, Bundle.entry:patient, Bundle.entry:practitioner, Bundle.entry:specimen, Bundle.entry:organization fullUrl cannot be a version specific reference fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-13 error Bundle A subscription-notification must have a SubscriptionStatus as the first resource type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
bdl-14 error Bundle entry.request.method PATCH not allowed for history type = 'history' implies entry.request.method != 'PATCH'
bdl-15 error Bundle Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
bdl-16 error Bundle Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
bdl-17 error Bundle Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. type = 'document' implies issues.empty()
bdl-18 error Bundle Self link is required for searchsets. type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
bdl-3a error Bundle For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3b error Bundle For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3c error Bundle For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3d error Bundle For collections of type transaction-response or batch-response, all entries must contain response elements type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ifnoneexist-on-identifier error Bundle.entry:patient.request.ifNoneExist, Bundle.entry:practitioner.request.ifNoneExist, Bundle.entry:organization.request.ifNoneExist ifNoneExist must key on the resource's external (secondary) or internal (usual) identifier, and must include a system: identifier=<system>|<value> $this.matches('^identifier=[^|]+\|[^|]+$')
no-barcode-on-create error Bundle.entry:specimen.resource The barcode label (SenaiteSpecimenBarcode) is generated by SENAITE and must not be supplied on an external create extension.where(url = 'https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode').empty()
no-internal-id-on-create error Bundle.entry:patient.resource, Bundle.entry:practitioner.resource, Bundle.entry:specimen.resource, Bundle.entry:organization.resource The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create identifier.where(use = 'usual').empty()
subject-identified error Bundle.entry:serviceRequest.resource.subject.reference If there is no identifier then it must have a key hasValue() or subject.identifier.count()
urn-uuid error Bundle.entry:serviceRequest.fullUrl, Bundle.entry:patient.fullUrl, Bundle.entry:practitioner.fullUrl, Bundle.entry:specimen.fullUrl, Bundle.entry:organization.fullUrl fullUrl must be a urn:uuid: reference for POST transaction entries matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle 0..* Bundle Contains a collection of resources
Bundle.identifier 0..0 Persistent identifier for the bundle
Bundle.type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Fixed Value: transaction (no extensions allowed)
Bundle.timestamp 0..0 When the bundle was assembled
Bundle.link 0..0 Links related to this Bundle
Bundle.Slices for entry 2..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
Bundle.Slices for entry.entry:serviceRequest 1..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:serviceRequest.fullUrl C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:serviceRequest.resource 1..1 SenaiteServiceRequest A request for a service to be performed
Bundle.Slices for entry.entry:serviceRequest.resource.id 0..0 Logical id of this artifact
Bundle.Slices for entry.entry:serviceRequest.search 0..0 Search related information
Bundle.Slices for entry.entry:serviceRequest.request 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:serviceRequest.request.method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.request.url 1..1 uri "ServiceRequest"
Bundle.Slices for entry.entry:serviceRequest.request.ifNoneExist 0..0 For conditional creates
Bundle.Slices for entry.entry:serviceRequest.response 0..0 Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:patient 0..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:patient.fullUrl C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:patient.resource C 1..1 SenaitePatient Information about an individual or animal receiving health care services
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:patient.resource.id 0..0 Logical id of this artifact
Bundle.Slices for entry.entry:patient.search 0..0 Search related information
Bundle.Slices for entry.entry:patient.request 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:patient.request.method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:patient.request.url 1..1 uri "Patient"
Bundle.Slices for entry.entry:patient.request.ifNoneExist C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.Slices for entry.entry:patient.response 0..0 Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:practitioner 0..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:practitioner.fullUrl C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:practitioner.resource C 1..1 SenaitePractitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:practitioner.resource.id 0..0 Logical id of this artifact
Bundle.Slices for entry.entry:practitioner.search 0..0 Search related information
Bundle.Slices for entry.entry:practitioner.request 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:practitioner.request.method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:practitioner.request.url 1..1 uri "Practitioner"
Bundle.Slices for entry.entry:practitioner.request.ifNoneExist C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.Slices for entry.entry:practitioner.response 0..0 Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:specimen 1..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:specimen.fullUrl C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:specimen.resource C 1..1 SenaiteSpecimen Sample for analysis
Constraints: no-internal-id-on-create, no-barcode-on-create
Bundle.Slices for entry.entry:specimen.resource.id 0..0 Logical id of this artifact
Bundle.Slices for entry.entry:specimen.search 0..0 Search related information
Bundle.Slices for entry.entry:specimen.request 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:specimen.request.method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:specimen.request.url 1..1 uri "Specimen"
Bundle.Slices for entry.entry:specimen.request.ifNoneExist 0..0 For conditional creates
Bundle.Slices for entry.entry:specimen.response 0..0 Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:organization 0..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:organization.fullUrl C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:organization.resource C 1..1 SenaiteOrganization A grouping of people or organizations with a common purpose
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:organization.resource.id 0..0 Logical id of this artifact
Bundle.Slices for entry.entry:organization.search 0..0 Search related information
Bundle.Slices for entry.entry:organization.request 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:organization.request.method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:organization.request.url 1..1 uri "Organization"
Bundle.Slices for entry.entry:organization.request.ifNoneExist C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.Slices for entry.entry:organization.response 0..0 Results of execution (transaction/batch/history)
Bundle.signature 0..0 Digital Signature

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ifnoneexist-on-identifier error Bundle.entry:patient.request.ifNoneExist, Bundle.entry:practitioner.request.ifNoneExist, Bundle.entry:organization.request.ifNoneExist ifNoneExist must key on the resource's external (secondary) or internal (usual) identifier, and must include a system: identifier=<system>|<value> $this.matches('^identifier=[^|]+\|[^|]+$')
no-barcode-on-create error Bundle.entry:specimen.resource The barcode label (SenaiteSpecimenBarcode) is generated by SENAITE and must not be supplied on an external create extension.where(url = 'https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode').empty()
no-internal-id-on-create error Bundle.entry:patient.resource, Bundle.entry:practitioner.resource, Bundle.entry:specimen.resource, Bundle.entry:organization.resource The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create identifier.where(use = 'usual').empty()
urn-uuid error Bundle.entry:serviceRequest.fullUrl, Bundle.entry:patient.fullUrl, Bundle.entry:practitioner.fullUrl, Bundle.entry:specimen.fullUrl, Bundle.entry:organization.fullUrl fullUrl must be a urn:uuid: reference for POST transaction entries matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d
Bundle.id This element is included in summaries. 0..1 id Logical id of this artifact
Bundle.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Bundle.type This element is included in summaries. C 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: transaction (no extensions allowed)
Bundle.Slices for entry This element is included in summaries. C 2..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:All Slices.fullUrl This element is included in summaries. C 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Bundle.Slices for entry.entry:All Slices.resource This element is included in summaries. C 0..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:All Slices.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:All Slices.search.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.search.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.search.mode This element is included in summaries. 0..1 code match | include - why this is in the result set
Binding: SearchEntryMode (required): 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.
Bundle.Slices for entry.entry:All Slices.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:All Slices.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Bundle.Slices for entry.entry:All Slices.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:All Slices.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache validation
Bundle.Slices for entry.entry:All Slices.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:All Slices.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:All Slices.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:All Slices.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.response.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.response.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:All Slices.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
Bundle.Slices for entry.entry:All Slices.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
Bundle.Slices for entry.entry:All Slices.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:All Slices.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
Bundle.Slices for entry.entry:serviceRequest This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:serviceRequest.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:serviceRequest.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:serviceRequest.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:serviceRequest.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:serviceRequest.resource 1..1 SenaiteServiceRequest Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A request for a service to be performed
Bundle.Slices for entry.entry:serviceRequest.resource.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.Slices for entry.entry:serviceRequest.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:serviceRequest.resource.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Bundle.Slices for entry.entry:serviceRequest.resource.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Bundle.Slices for entry.entry:serviceRequest.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:serviceRequest.resource.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.Slices for extension Content/Rules for all slices
Bundle.Slices for entry.entry:serviceRequest.resource.Slices for extension.extension:client 1..1 Reference(SenaiteOrganization) The submitting client organisation
URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient
Bundle.Slices for entry.entry:serviceRequest.resource.requisition This element is included in summaries. 0..1 Identifier Order grouping identifier, shared by the ServiceRequests of one multi-tube order
Bundle.Slices for entry.entry:serviceRequest.resource.requisition.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.requisition.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.requisition.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.requisition.value This element is included in summaries. C 1..1 string Requisition value — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:serviceRequest.resource.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | entered-in-error
Binding: RequestStatus (required): The status of a service order.
Bundle.Slices for entry.entry:serviceRequest.resource.intent This element is a modifier element. This element is included in summaries. 1..1 code order | reflex-order
Binding: RequestIntent (required): The kind of service request.
Fixed Value: order (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.category This element is included in summaries. 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (required): Classification of the requested service.
Bundle.Slices for entry.entry:serviceRequest.resource.category.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.category.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.category.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Bundle.Slices for entry.entry:serviceRequest.resource.category.coding.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.category.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.category.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.category.coding.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
Fixed Value: 108252007 (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.category.coding.display This element is included in summaries. C 0..1 string Representation defined by the system
Fixed Value: Laboratory procedure (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.category.text This element is included in summaries. 0..1 string Plain text representation of the concept
Fixed Value: Laboratory procedure (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.priority This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
Bundle.Slices for entry.entry:serviceRequest.resource.code This element is included in summaries. C 1..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
Binding: http://loinc.org (preferred): For laboratory codes
Bundle.Slices for entry.entry:serviceRequest.resource.code.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.code.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.code.concept This element is included in summaries. 0..1 CodeableConcept Reference to a concept (by class)
Bundle.Slices for entry.entry:serviceRequest.resource.code.reference This element is included in summaries. 0..1 Reference() Reference to a resource (by instance)
Bundle.Slices for entry.entry:serviceRequest.resource.orderDetail This element is included in summaries. C 0..* BackboneElement Additional order information
Bundle.Slices for entry.entry:serviceRequest.resource.orderDetail.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.orderDetail.parameter This element is included in summaries. 1..* BackboneElement The parameter details for the service being requested
Bundle.Slices for entry.entry:serviceRequest.resource.orderDetail.parameter.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.orderDetail.parameter.code This element is included in summaries. 1..1 CodeableConcept The detail of the order being requested
Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ObservationValue",
      "code" : "LOINC",
      "display" : "Test Code"
    }
  ]
}
Bundle.Slices for entry.entry:serviceRequest.resource.orderDetail.parameter.value[x] This element is included in summaries. 1..1 CodeableConcept The value for the order detail
Binding: http://loinc.org (preferred): LOINC codes for individual laboratory tests
Bundle.Slices for entry.entry:serviceRequest.resource.subject This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
Bundle.Slices for entry.entry:serviceRequest.resource.subject.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.subject.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.subject.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Constraints: subject-identified
Bundle.Slices for entry.entry:serviceRequest.resource.subject.display This element is included in summaries. C 0..1 string Text alternative for the resource
Bundle.Slices for entry.entry:serviceRequest.resource.focus This element is included in summaries. 0..* Reference(Resource) What the service request is about, when it is not about the subject of record
Bundle.Slices for entry.entry:serviceRequest.resource.requester This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
Bundle.Slices for entry.entry:serviceRequest.resource.requester.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.requester.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.requester.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Bundle.Slices for entry.entry:serviceRequest.resource.requester.type This element is included in summaries. 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: Practitioner (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.specimen This element is included in summaries. 1..1 Reference(Specimen) Procedure Samples
Bundle.Slices for entry.entry:serviceRequest.resource.specimen.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.specimen.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.specimen.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Bundle.Slices for entry.entry:serviceRequest.resource.specimen.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Bundle.Slices for entry.entry:serviceRequest.resource.specimen.identifier This element is included in summaries. C 0..1 Identifier Logical reference, when literal reference is not known
Bundle.Slices for entry.entry:serviceRequest.resource.specimen.display This element is included in summaries. C 0..1 string Text alternative for the resource
Bundle.Slices for entry.entry:serviceRequest.resource.bodyStructure This element is included in summaries. C 0..1 Reference(BodyStructure) BodyStructure-based location on the body
Bundle.Slices for entry.entry:serviceRequest.resource.note 0..* Annotation Comments
Bundle.Slices for entry.entry:serviceRequest.resource.note.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.note.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.note.text This element is included in summaries. 1..1 markdown The annotation - text content (as markdown)
Bundle.Slices for entry.entry:serviceRequest.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:serviceRequest.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:serviceRequest.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:serviceRequest.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.request.url This element is included in summaries. 1..1 uri "ServiceRequest"
Bundle.Slices for entry.entry:serviceRequest.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache validation
Bundle.Slices for entry.entry:serviceRequest.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:serviceRequest.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:patient This element is included in summaries. C 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:patient.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:patient.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:patient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:patient.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:patient.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:patient.resource C 1..1 SenaitePatient Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Information about an individual or animal receiving health care services
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:patient.resource.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.Slices for entry.entry:patient.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:patient.resource.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Bundle.Slices for entry.entry:patient.resource.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Bundle.Slices for entry.entry:patient.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:patient.resource.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:patient.resource.Slices for extension Content/Rules for all slices
Bundle.Slices for entry.entry:patient.resource.Slices for extension.extension:estimatedDateBirth 0..1 boolean If the date of birth was not known precisely
URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth
Bundle.Slices for entry.entry:patient.resource.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:patient.resource.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:use
Bundle.Slices for entry.entry:patient.resource.Slices for identifier Content/Rules for all slices
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Patient ID — server-assigned, do not include on create
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Internal Patient ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/patient-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE patient identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn This element is included in summaries. 0..1 Identifier External Patient ID from the consumer's system — may be supplied on create
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.system This element is included in summaries. 1..1 uri External Patient ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/patient-mrn
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.value This element is included in summaries. C 1..1 string External patient identifier, typically an MRN — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:patient.resource.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Bundle.Slices for entry.entry:patient.resource.name This element is included in summaries. 1..* HumanName A name associated with the patient
Bundle.Slices for entry.entry:patient.resource.name.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:patient.resource.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:patient.resource.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Bundle.Slices for entry.entry:patient.resource.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Bundle.Slices for entry.entry:patient.resource.name.given This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Bundle.Slices for entry.entry:patient.resource.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Bundle.Slices for entry.entry:patient.resource.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Bundle.Slices for entry.entry:patient.resource.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Bundle.Slices for entry.entry:patient.resource.telecom.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:patient.resource.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:patient.resource.telecom.system This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Bundle.Slices for entry.entry:patient.resource.telecom.value This element is included in summaries. C 0..1 string The actual contact point details
Bundle.Slices for entry.entry:patient.resource.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Bundle.Slices for entry.entry:patient.resource.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Bundle.Slices for entry.entry:patient.resource.gender This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Bundle.Slices for entry.entry:patient.resource.birthDate This element is included in summaries. 1..1 date The date of birth for the individual
Bundle.Slices for entry.entry:patient.resource.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 dateTime Indicates if the individual is deceased or not
Bundle.Slices for entry.entry:patient.resource.address This element is included in summaries. 0..* Address An address for the individual
Bundle.Slices for entry.entry:patient.resource.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (required): The domestic partnership status of a person.
Bundle.Slices for entry.entry:patient.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:patient.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:patient.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:patient.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:patient.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:patient.request.url This element is included in summaries. 1..1 uri "Patient"
Bundle.Slices for entry.entry:patient.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache validation
Bundle.Slices for entry.entry:patient.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:patient.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:patient.request.ifNoneExist This element is included in summaries. C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.Slices for entry.entry:practitioner This element is included in summaries. C 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:practitioner.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:practitioner.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:practitioner.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:practitioner.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:practitioner.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:practitioner.resource C 1..1 SenaitePractitioner Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:practitioner.resource.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.Slices for entry.entry:practitioner.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:practitioner.resource.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Bundle.Slices for entry.entry:practitioner.resource.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Bundle.Slices for entry.entry:practitioner.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for the person as this agent
Slice: Unordered, Closed by value:use
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier Content/Rules for all slices
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Practitioner ID — server-assigned, do not include on create
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Internal Practitioner ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/practitioner-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE practitioner identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId This element is included in summaries. 0..1 Identifier External Practitioner ID from the consumer's system — may be supplied on create
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.system This element is included in summaries. 1..1 uri External Practitioner ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/practitioner-external-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.value This element is included in summaries. C 1..1 string External practitioner identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:practitioner.resource.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this practitioner's record is in active use
Bundle.Slices for entry.entry:practitioner.resource.name This element is included in summaries. 1..1 HumanName The name(s) associated with the practitioner
Bundle.Slices for entry.entry:practitioner.resource.name.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:practitioner.resource.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:practitioner.resource.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Bundle.Slices for entry.entry:practitioner.resource.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Bundle.Slices for entry.entry:practitioner.resource.name.given This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Bundle.Slices for entry.entry:practitioner.resource.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Bundle.Slices for entry.entry:practitioner.resource.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Bundle.Slices for entry.entry:practitioner.resource.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
Bundle.Slices for entry.entry:practitioner.resource.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Bundle.Slices for entry.entry:practitioner.resource.birthDate This element is included in summaries. 0..1 date The date on which the practitioner was born
Bundle.Slices for entry.entry:practitioner.resource.address This element is included in summaries. 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
Bundle.Slices for entry.entry:practitioner.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:practitioner.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:practitioner.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:practitioner.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:practitioner.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:practitioner.request.url This element is included in summaries. 1..1 uri "Practitioner"
Bundle.Slices for entry.entry:practitioner.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache validation
Bundle.Slices for entry.entry:practitioner.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:practitioner.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:practitioner.request.ifNoneExist This element is included in summaries. C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.Slices for entry.entry:specimen This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:specimen.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:specimen.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:specimen.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:specimen.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:specimen.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:specimen.resource C 1..1 SenaiteSpecimen Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Sample for analysis
Constraints: no-internal-id-on-create, no-barcode-on-create
Bundle.Slices for entry.entry:specimen.resource.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.Slices for entry.entry:specimen.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:specimen.resource.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Bundle.Slices for entry.entry:specimen.resource.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Bundle.Slices for entry.entry:specimen.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:specimen.resource.Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by
Bundle.Slices for entry.entry:specimen.resource.Slices for extension Content/Rules for all slices
Bundle.Slices for entry.entry:specimen.resource.Slices for extension.extension:barcode 0..1 Attachment Barcode label (base64 PDF or image) — SHALL be present when returned by SENAITE; SHALL NOT be supplied on create
URL: https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier This element is included in summaries. 0..* Identifier External Identifier
Slice: Unordered, Closed by value:use
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier Content/Rules for all slices
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Sample ID — matches the DiagnosticReport usual identifier
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed)
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE sample identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId This element is included in summaries. 0..1 Identifier External Client Sample ID assigned by the consumer's system — may be supplied on create
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.system This element is included in summaries. 1..1 uri Client Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/client-sample-id (no extensions allowed)
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.value This element is included in summaries. C 1..1 string Client Sample ID — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:specimen.resource.status This element is a modifier element. This element is included in summaries. 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
Bundle.Slices for entry.entry:specimen.resource.type This element is included in summaries. 1..1 CodeableConcept Kind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.
Bundle.Slices for entry.entry:specimen.resource.type.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:specimen.resource.type.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:specimen.resource.type.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
Binding: http://snomed.info/sct (preferred)
Bundle.Slices for entry.entry:specimen.resource.type.coding.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:specimen.resource.type.coding.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:specimen.resource.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Bundle.Slices for entry.entry:specimen.resource.type.coding.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
Bundle.Slices for entry.entry:specimen.resource.type.coding.display This element is included in summaries. C 0..1 string Representation defined by the system
Bundle.Slices for entry.entry:specimen.resource.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Bundle.Slices for entry.entry:specimen.resource.collection 1..1 BackboneElement Collection details
Bundle.Slices for entry.entry:specimen.resource.collection.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:specimen.resource.collection.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:specimen.resource.collection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:specimen.resource.collection.collector This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who collected the specimen
Bundle.Slices for entry.entry:specimen.resource.collection.collected[x] This element is included in summaries. 0..1 dateTime Collection time
Bundle.Slices for entry.entry:specimen.resource.collection.device 0..1 CodeableReference(Device) Device used to perform collection
Binding Description: (example): The device that was used to obtain the specimen (e.g. a catheter or catheter part used to draw the blood via a central line).
Bundle.Slices for entry.entry:specimen.resource.collection.procedure 0..1 Reference(Procedure) The procedure that collects the specimen
Bundle.Slices for entry.entry:specimen.resource.collection.bodySite 0..1 CodeableReference(BodyStructure) Anatomical collection site
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
Bundle.Slices for entry.entry:specimen.resource.note 0..* Annotation Comments
Bundle.Slices for entry.entry:specimen.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:specimen.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:specimen.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:specimen.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:specimen.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:specimen.request.url This element is included in summaries. 1..1 uri "Specimen"
Bundle.Slices for entry.entry:specimen.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache validation
Bundle.Slices for entry.entry:specimen.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:specimen.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:organization This element is included in summaries. C 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:organization.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:organization.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:organization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:organization.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:organization.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:organization.resource C 1..1 SenaiteOrganization Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A grouping of people or organizations with a common purpose
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:organization.resource.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.Slices for entry.entry:organization.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:organization.resource.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Bundle.Slices for entry.entry:organization.resource.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Bundle.Slices for entry.entry:organization.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:organization.resource.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:organization.resource.Slices for identifier This element is included in summaries. C 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Closed by value:use
Bundle.Slices for entry.entry:organization.resource.Slices for identifier Content/Rules for all slices
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId This element is included in summaries. C 0..1 Identifier Internal SENAITE Client ID — server-assigned, do not include on create
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Internal Organization ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/organization-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE client identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId This element is included in summaries. C 0..1 Identifier External Organization ID from the consumer's system — may be supplied on create
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.system This element is included in summaries. 1..1 uri External Organization ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/organization-external-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.value This element is included in summaries. C 1..1 string External organisation identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:organization.resource.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether the organization's record is still in active use
Bundle.Slices for entry.entry:organization.resource.name This element is included in summaries. C 1..1 string Name used for the organization
Bundle.Slices for entry.entry:organization.resource.contact C 0..* ExtendedContactDetail Official contact details for the Organization
Constraints: org-3, org-4
Bundle.Slices for entry.entry:organization.resource.partOf This element is included in summaries. 0..1 Reference(Organization) The organization of which this organization forms a part
Bundle.Slices for entry.entry:organization.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:organization.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:organization.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:organization.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:organization.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:organization.request.url This element is included in summaries. 1..1 uri "Organization"
Bundle.Slices for entry.entry:organization.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache validation
Bundle.Slices for entry.entry:organization.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:organization.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:organization.request.ifNoneExist This element is included in summaries. C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.issues This element is included in summaries. C 0..1 OperationOutcome(5.0.0) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Issues with the Bundle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.type Base required Bundle Type 📍5.0.0 FHIR Std.
Bundle.link.relation Base required Link Relation Types 📍5.0.0 FHIR Std.
Bundle.entry.search.​mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry.request.​method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.status Base required RequestStatus 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.intent Base required RequestIntent 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.category Base required Service Request Category Codes 📦5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.priority Base required RequestPriority 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.code Base preferred http://loinc.org Not State Unknown
Bundle.entry:serviceRequest.​resource.orderDetail.​parameter.code Base example Servicerequest OrderDetail Parameter Code 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.orderDetail.​parameter.value[x] Base preferred http://loinc.org Not State Unknown
Bundle.entry:serviceRequest.​resource.requester.type Base extensible Resource Types 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.specimen.type Base extensible Resource Types 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​search.mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.identifier:mrn.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.identifier:mrn.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.name.use Base required NameUse 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.telecom.system Base required ContactPointSystem 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.telecom.use Base required ContactPointUse 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.maritalStatus Base required Marital Status Codes 📦5.0.0 FHIR Std.
Bundle.entry:patient.​resource.contact.relationship Base extensible Patient Contact Relationship 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.contact.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.link.type Base required Link Type 📍5.0.0 FHIR Std.
Bundle.entry:patient.​search.mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry:patient.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.identifier:externalId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.identifier:externalId.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.name.use Base required NameUse 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.qualification.​code Base example hl7VS-degreeLicenseCertificate 📦3.0.0 THO v7.5
Bundle.entry:practitioner.​resource.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​search.mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.identifier:clientSampleId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.identifier:clientSampleId.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.status Base required Specimen Status 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.type Base example hl7VS-specimenType 📦3.0.0 THO v7.5
Bundle.entry:specimen.​resource.type.coding Base preferred http://snomed.info/sct Not State Unknown
Bundle.entry:specimen.​resource.feature.type Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.collection.​device Base example Not State Unknown
Bundle.entry:specimen.​resource.collection.​bodySite Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.processing.​method Base example Specimen Processing Method 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​search.mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:organization.​resource.language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:organization.​resource.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:organization.​resource.identifier:externalId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:organization.​resource.identifier:externalId.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Bundle.entry:organization.​resource.qualification.​code Base example Not State Unknown
Bundle.entry:organization.​search.mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry:organization.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search (type = 'searchset') or entry.search.empty()
bdl-5 error Bundle.entry, Bundle.entry:serviceRequest, Bundle.entry:patient, Bundle.entry:practitioner, Bundle.entry:specimen, Bundle.entry:organization must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
bdl-8 error Bundle.entry, Bundle.entry:serviceRequest, Bundle.entry:patient, Bundle.entry:practitioner, Bundle.entry:specimen, Bundle.entry:organization fullUrl cannot be a version specific reference fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-13 error Bundle A subscription-notification must have a SubscriptionStatus as the first resource type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
bdl-14 error Bundle entry.request.method PATCH not allowed for history type = 'history' implies entry.request.method != 'PATCH'
bdl-15 error Bundle Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
bdl-16 error Bundle Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
bdl-17 error Bundle Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. type = 'document' implies issues.empty()
bdl-18 error Bundle Self link is required for searchsets. type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
bdl-3a error Bundle For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3b error Bundle For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3c error Bundle For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3d error Bundle For collections of type transaction-response or batch-response, all entries must contain response elements type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ifnoneexist-on-identifier error Bundle.entry:patient.request.ifNoneExist, Bundle.entry:practitioner.request.ifNoneExist, Bundle.entry:organization.request.ifNoneExist ifNoneExist must key on the resource's external (secondary) or internal (usual) identifier, and must include a system: identifier=<system>|<value> $this.matches('^identifier=[^|]+\|[^|]+$')
no-barcode-on-create error Bundle.entry:specimen.resource The barcode label (SenaiteSpecimenBarcode) is generated by SENAITE and must not be supplied on an external create extension.where(url = 'https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode').empty()
no-internal-id-on-create error Bundle.entry:patient.resource, Bundle.entry:practitioner.resource, Bundle.entry:specimen.resource, Bundle.entry:organization.resource The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create identifier.where(use = 'usual').empty()
org-3 error Bundle.entry:organization.resource.contact The telecom of an organization can never be of use 'home' telecom.where(use = 'home').empty()
org-4 error Bundle.entry:organization.resource.contact The address of an organization can never be of use 'home' address.where(use = 'home').empty()
sqty-1 error Bundle.entry:specimen.resource.container.specimenQuantity The comparator is not used on a SimpleQuantity comparator.empty()
subject-identified error Bundle.entry:serviceRequest.resource.subject.reference If there is no identifier then it must have a key hasValue() or subject.identifier.count()
urn-uuid error Bundle.entry:serviceRequest.fullUrl, Bundle.entry:patient.fullUrl, Bundle.entry:practitioner.fullUrl, Bundle.entry:specimen.fullUrl, Bundle.entry:organization.fullUrl fullUrl must be a urn:uuid: reference for POST transaction entries matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')

This structure is derived from Bundle

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d
Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.type This element is included in summaries. C 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: transaction (no extensions allowed)
Bundle.Slices for entry This element is included in summaries. C 2..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.fullUrl This element is included in summaries. C 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Bundle.Slices for entry.entry:All Slices.resource This element is included in summaries. C 0..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:All Slices.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Bundle.Slices for entry.entry:All Slices.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:All Slices.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:serviceRequest This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:serviceRequest.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:serviceRequest.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:serviceRequest.resource 1..1 SenaiteServiceRequest Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A request for a service to be performed
Bundle.Slices for entry.entry:serviceRequest.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:serviceRequest.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:serviceRequest.resource.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.Slices for extension Content/Rules for all slices
Bundle.Slices for entry.entry:serviceRequest.resource.Slices for extension.extension:client 1..1 Reference(SenaiteOrganization) The submitting client organisation
URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient
Bundle.Slices for entry.entry:serviceRequest.resource.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | entered-in-error
Binding: RequestStatus (required): The status of a service order.
Bundle.Slices for entry.entry:serviceRequest.resource.intent This element is a modifier element. This element is included in summaries. 1..1 code order | reflex-order
Binding: RequestIntent (required): The kind of service request.
Fixed Value: order (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.category This element is included in summaries. 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (required): Classification of the requested service.
Bundle.Slices for entry.entry:serviceRequest.resource.category.text This element is included in summaries. 0..1 string Plain text representation of the concept
Fixed Value: Laboratory procedure (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.code This element is included in summaries. C 1..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
Binding: http://loinc.org (preferred): For laboratory codes
Bundle.Slices for entry.entry:serviceRequest.resource.code.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.subject This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
Bundle.Slices for entry.entry:serviceRequest.resource.subject.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Constraints: subject-identified
Bundle.Slices for entry.entry:serviceRequest.resource.specimen This element is included in summaries. 1..1 Reference(Specimen) Procedure Samples
Bundle.Slices for entry.entry:serviceRequest.resource.specimen.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Bundle.Slices for entry.entry:serviceRequest.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:serviceRequest.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:serviceRequest.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.request.url This element is included in summaries. 1..1 uri "ServiceRequest"
Bundle.Slices for entry.entry:patient This element is included in summaries. C 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:patient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:patient.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:patient.resource C 1..1 SenaitePatient Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Information about an individual or animal receiving health care services
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:patient.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:patient.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:patient.resource.Slices for extension Content/Rules for all slices
Bundle.Slices for entry.entry:patient.resource.Slices for extension.extension:estimatedDateBirth 0..1 boolean If the date of birth was not known precisely
URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth
Bundle.Slices for entry.entry:patient.resource.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:patient.resource.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:use
Bundle.Slices for entry.entry:patient.resource.Slices for identifier Content/Rules for all slices
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Patient ID — server-assigned, do not include on create
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Internal Patient ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/patient-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE patient identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn This element is included in summaries. 0..1 Identifier External Patient ID from the consumer's system — may be supplied on create
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.system This element is included in summaries. 1..1 uri External Patient ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/patient-mrn
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.value This element is included in summaries. C 1..1 string External patient identifier, typically an MRN — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:patient.resource.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Bundle.Slices for entry.entry:patient.resource.name This element is included in summaries. 1..* HumanName A name associated with the patient
Bundle.Slices for entry.entry:patient.resource.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Bundle.Slices for entry.entry:patient.resource.gender This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Bundle.Slices for entry.entry:patient.resource.birthDate This element is included in summaries. 1..1 date The date of birth for the individual
Bundle.Slices for entry.entry:patient.resource.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 dateTime Indicates if the individual is deceased or not
Bundle.Slices for entry.entry:patient.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:patient.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:patient.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:patient.request.url This element is included in summaries. 1..1 uri "Patient"
Bundle.Slices for entry.entry:patient.request.ifNoneExist This element is included in summaries. C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.Slices for entry.entry:practitioner This element is included in summaries. C 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:practitioner.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:practitioner.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:practitioner.resource C 1..1 SenaitePractitioner Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:practitioner.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:practitioner.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for the person as this agent
Slice: Unordered, Closed by value:use
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier Content/Rules for all slices
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Practitioner ID — server-assigned, do not include on create
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Internal Practitioner ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/practitioner-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE practitioner identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId This element is included in summaries. 0..1 Identifier External Practitioner ID from the consumer's system — may be supplied on create
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.system This element is included in summaries. 1..1 uri External Practitioner ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/practitioner-external-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.value This element is included in summaries. C 1..1 string External practitioner identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:practitioner.resource.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this practitioner's record is in active use
Bundle.Slices for entry.entry:practitioner.resource.name This element is included in summaries. 1..1 HumanName The name(s) associated with the practitioner
Bundle.Slices for entry.entry:practitioner.resource.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Bundle.Slices for entry.entry:practitioner.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:practitioner.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:practitioner.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:practitioner.request.url This element is included in summaries. 1..1 uri "Practitioner"
Bundle.Slices for entry.entry:practitioner.request.ifNoneExist This element is included in summaries. C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.Slices for entry.entry:specimen This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:specimen.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:specimen.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:specimen.resource C 1..1 SenaiteSpecimen Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Sample for analysis
Constraints: no-internal-id-on-create, no-barcode-on-create
Bundle.Slices for entry.entry:specimen.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:specimen.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:specimen.resource.Slices for extension Content/Rules for all slices
Bundle.Slices for entry.entry:specimen.resource.Slices for extension.extension:barcode 0..1 Attachment Barcode label (base64 PDF or image) — SHALL be present when returned by SENAITE; SHALL NOT be supplied on create
URL: https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier This element is included in summaries. 0..* Identifier External Identifier
Slice: Unordered, Closed by value:use
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier Content/Rules for all slices
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Sample ID — matches the DiagnosticReport usual identifier
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed)
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE sample identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId This element is included in summaries. 0..1 Identifier External Client Sample ID assigned by the consumer's system — may be supplied on create
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.system This element is included in summaries. 1..1 uri Client Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/client-sample-id (no extensions allowed)
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.value This element is included in summaries. C 1..1 string Client Sample ID — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:specimen.resource.status This element is a modifier element. This element is included in summaries. 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
Bundle.Slices for entry.entry:specimen.resource.type This element is included in summaries. 1..1 CodeableConcept Kind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.
Bundle.Slices for entry.entry:specimen.resource.type.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:specimen.resource.type.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
Binding: http://snomed.info/sct (preferred)
Bundle.Slices for entry.entry:specimen.resource.type.coding.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:specimen.resource.collection 1..1 BackboneElement Collection details
Bundle.Slices for entry.entry:specimen.resource.collection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:specimen.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:specimen.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:specimen.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:specimen.request.url This element is included in summaries. 1..1 uri "Specimen"
Bundle.Slices for entry.entry:organization This element is included in summaries. C 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:organization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:organization.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:organization.resource C 1..1 SenaiteOrganization Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A grouping of people or organizations with a common purpose
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:organization.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:organization.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:organization.resource.Slices for identifier This element is included in summaries. C 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Closed by value:use
Bundle.Slices for entry.entry:organization.resource.Slices for identifier Content/Rules for all slices
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId This element is included in summaries. C 0..1 Identifier Internal SENAITE Client ID — server-assigned, do not include on create
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Internal Organization ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/organization-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE client identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId This element is included in summaries. C 0..1 Identifier External Organization ID from the consumer's system — may be supplied on create
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.system This element is included in summaries. 1..1 uri External Organization ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/organization-external-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.value This element is included in summaries. C 1..1 string External organisation identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:organization.resource.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether the organization's record is still in active use
Bundle.Slices for entry.entry:organization.resource.name This element is included in summaries. C 1..1 string Name used for the organization
Bundle.Slices for entry.entry:organization.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:organization.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:organization.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:organization.request.url This element is included in summaries. 1..1 uri "Organization"
Bundle.Slices for entry.entry:organization.request.ifNoneExist This element is included in summaries. C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.issues This element is included in summaries. C 0..1 OperationOutcome(5.0.0) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Issues with the Bundle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.type Base required Bundle Type 📍5.0.0 FHIR Std.
Bundle.link.relation Base required Link Relation Types 📍5.0.0 FHIR Std.
Bundle.entry.request.​method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.status Base required RequestStatus 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.intent Base required RequestIntent 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.category Base required Service Request Category Codes 📦5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.code Base preferred http://loinc.org Not State Unknown
Bundle.entry:serviceRequest.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.identifier:mrn.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.name.use Base required NameUse 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.link.type Base required Link Type 📍5.0.0 FHIR Std.
Bundle.entry:patient.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.identifier:externalId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.name.use Base required NameUse 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.qualification.​code Base example hl7VS-degreeLicenseCertificate 📦3.0.0 THO v7.5
Bundle.entry:practitioner.​resource.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.identifier:clientSampleId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.status Base required Specimen Status 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.type Base example hl7VS-specimenType 📦3.0.0 THO v7.5
Bundle.entry:specimen.​resource.type.coding Base preferred http://snomed.info/sct Not State Unknown
Bundle.entry:specimen.​resource.feature.type Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:organization.​resource.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:organization.​resource.identifier:externalId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:organization.​resource.qualification.​code Base example Not State Unknown
Bundle.entry:organization.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search (type = 'searchset') or entry.search.empty()
bdl-5 error Bundle.entry, Bundle.entry:serviceRequest, Bundle.entry:patient, Bundle.entry:practitioner, Bundle.entry:specimen, Bundle.entry:organization must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
bdl-8 error Bundle.entry, Bundle.entry:serviceRequest, Bundle.entry:patient, Bundle.entry:practitioner, Bundle.entry:specimen, Bundle.entry:organization fullUrl cannot be a version specific reference fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-13 error Bundle A subscription-notification must have a SubscriptionStatus as the first resource type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
bdl-14 error Bundle entry.request.method PATCH not allowed for history type = 'history' implies entry.request.method != 'PATCH'
bdl-15 error Bundle Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
bdl-16 error Bundle Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
bdl-17 error Bundle Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. type = 'document' implies issues.empty()
bdl-18 error Bundle Self link is required for searchsets. type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
bdl-3a error Bundle For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3b error Bundle For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3c error Bundle For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3d error Bundle For collections of type transaction-response or batch-response, all entries must contain response elements type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ifnoneexist-on-identifier error Bundle.entry:patient.request.ifNoneExist, Bundle.entry:practitioner.request.ifNoneExist, Bundle.entry:organization.request.ifNoneExist ifNoneExist must key on the resource's external (secondary) or internal (usual) identifier, and must include a system: identifier=<system>|<value> $this.matches('^identifier=[^|]+\|[^|]+$')
no-barcode-on-create error Bundle.entry:specimen.resource The barcode label (SenaiteSpecimenBarcode) is generated by SENAITE and must not be supplied on an external create extension.where(url = 'https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode').empty()
no-internal-id-on-create error Bundle.entry:patient.resource, Bundle.entry:practitioner.resource, Bundle.entry:specimen.resource, Bundle.entry:organization.resource The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create identifier.where(use = 'usual').empty()
subject-identified error Bundle.entry:serviceRequest.resource.subject.reference If there is no identifier then it must have a key hasValue() or subject.identifier.count()
urn-uuid error Bundle.entry:serviceRequest.fullUrl, Bundle.entry:patient.fullUrl, Bundle.entry:practitioner.fullUrl, Bundle.entry:specimen.fullUrl, Bundle.entry:organization.fullUrl fullUrl must be a urn:uuid: reference for POST transaction entries matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle 0..* Bundle Contains a collection of resources
Bundle.identifier 0..0 Persistent identifier for the bundle
Bundle.type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Fixed Value: transaction (no extensions allowed)
Bundle.timestamp 0..0 When the bundle was assembled
Bundle.total 0..0 If search, the total number of matches
Bundle.link 0..0 Links related to this Bundle
Bundle.Slices for entry 2..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
Bundle.Slices for entry.entry:serviceRequest 1..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:serviceRequest.fullUrl C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:serviceRequest.resource 1..1 SenaiteServiceRequest A request for a service to be performed
Bundle.Slices for entry.entry:serviceRequest.resource.id 0..0 Logical id of this artifact
Bundle.Slices for entry.entry:serviceRequest.search 0..0 Search related information
Bundle.Slices for entry.entry:serviceRequest.request 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:serviceRequest.request.method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.request.url 1..1 uri "ServiceRequest"
Bundle.Slices for entry.entry:serviceRequest.request.ifNoneExist 0..0 For conditional creates
Bundle.Slices for entry.entry:serviceRequest.response 0..0 Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:patient 0..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:patient.fullUrl C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:patient.resource C 1..1 SenaitePatient Information about an individual or animal receiving health care services
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:patient.resource.id 0..0 Logical id of this artifact
Bundle.Slices for entry.entry:patient.search 0..0 Search related information
Bundle.Slices for entry.entry:patient.request 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:patient.request.method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:patient.request.url 1..1 uri "Patient"
Bundle.Slices for entry.entry:patient.request.ifNoneExist C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.Slices for entry.entry:patient.response 0..0 Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:practitioner 0..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:practitioner.fullUrl C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:practitioner.resource C 1..1 SenaitePractitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:practitioner.resource.id 0..0 Logical id of this artifact
Bundle.Slices for entry.entry:practitioner.search 0..0 Search related information
Bundle.Slices for entry.entry:practitioner.request 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:practitioner.request.method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:practitioner.request.url 1..1 uri "Practitioner"
Bundle.Slices for entry.entry:practitioner.request.ifNoneExist C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.Slices for entry.entry:practitioner.response 0..0 Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:specimen 1..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:specimen.fullUrl C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:specimen.resource C 1..1 SenaiteSpecimen Sample for analysis
Constraints: no-internal-id-on-create, no-barcode-on-create
Bundle.Slices for entry.entry:specimen.resource.id 0..0 Logical id of this artifact
Bundle.Slices for entry.entry:specimen.search 0..0 Search related information
Bundle.Slices for entry.entry:specimen.request 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:specimen.request.method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:specimen.request.url 1..1 uri "Specimen"
Bundle.Slices for entry.entry:specimen.request.ifNoneExist 0..0 For conditional creates
Bundle.Slices for entry.entry:specimen.response 0..0 Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:organization 0..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:organization.fullUrl C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:organization.resource C 1..1 SenaiteOrganization A grouping of people or organizations with a common purpose
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:organization.resource.id 0..0 Logical id of this artifact
Bundle.Slices for entry.entry:organization.search 0..0 Search related information
Bundle.Slices for entry.entry:organization.request 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:organization.request.method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:organization.request.url 1..1 uri "Organization"
Bundle.Slices for entry.entry:organization.request.ifNoneExist C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.Slices for entry.entry:organization.response 0..0 Results of execution (transaction/batch/history)
Bundle.signature 0..0 Digital Signature

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ifnoneexist-on-identifier error Bundle.entry:patient.request.ifNoneExist, Bundle.entry:practitioner.request.ifNoneExist, Bundle.entry:organization.request.ifNoneExist ifNoneExist must key on the resource's external (secondary) or internal (usual) identifier, and must include a system: identifier=<system>|<value> $this.matches('^identifier=[^|]+\|[^|]+$')
no-barcode-on-create error Bundle.entry:specimen.resource The barcode label (SenaiteSpecimenBarcode) is generated by SENAITE and must not be supplied on an external create extension.where(url = 'https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode').empty()
no-internal-id-on-create error Bundle.entry:patient.resource, Bundle.entry:practitioner.resource, Bundle.entry:specimen.resource, Bundle.entry:organization.resource The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create identifier.where(use = 'usual').empty()
urn-uuid error Bundle.entry:serviceRequest.fullUrl, Bundle.entry:patient.fullUrl, Bundle.entry:practitioner.fullUrl, Bundle.entry:specimen.fullUrl, Bundle.entry:organization.fullUrl fullUrl must be a urn:uuid: reference for POST transaction entries matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d
Bundle.id This element is included in summaries. 0..1 id Logical id of this artifact
Bundle.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Bundle.type This element is included in summaries. C 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: transaction (no extensions allowed)
Bundle.Slices for entry This element is included in summaries. C 2..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:All Slices.fullUrl This element is included in summaries. C 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Bundle.Slices for entry.entry:All Slices.resource This element is included in summaries. C 0..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:All Slices.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:All Slices.search.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.search.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.search.mode This element is included in summaries. 0..1 code match | include - why this is in the result set
Binding: SearchEntryMode (required): 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.
Bundle.Slices for entry.entry:All Slices.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:All Slices.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Bundle.Slices for entry.entry:All Slices.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:All Slices.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache validation
Bundle.Slices for entry.entry:All Slices.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:All Slices.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:All Slices.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:All Slices.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.response.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.response.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:All Slices.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
Bundle.Slices for entry.entry:All Slices.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
Bundle.Slices for entry.entry:All Slices.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:All Slices.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
Bundle.Slices for entry.entry:serviceRequest This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:serviceRequest.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:serviceRequest.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:serviceRequest.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:serviceRequest.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:serviceRequest.resource 1..1 SenaiteServiceRequest Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A request for a service to be performed
Bundle.Slices for entry.entry:serviceRequest.resource.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.Slices for entry.entry:serviceRequest.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:serviceRequest.resource.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Bundle.Slices for entry.entry:serviceRequest.resource.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Bundle.Slices for entry.entry:serviceRequest.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:serviceRequest.resource.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.Slices for extension Content/Rules for all slices
Bundle.Slices for entry.entry:serviceRequest.resource.Slices for extension.extension:client 1..1 Reference(SenaiteOrganization) The submitting client organisation
URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient
Bundle.Slices for entry.entry:serviceRequest.resource.requisition This element is included in summaries. 0..1 Identifier Order grouping identifier, shared by the ServiceRequests of one multi-tube order
Bundle.Slices for entry.entry:serviceRequest.resource.requisition.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.requisition.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.requisition.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.requisition.value This element is included in summaries. C 1..1 string Requisition value — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:serviceRequest.resource.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | entered-in-error
Binding: RequestStatus (required): The status of a service order.
Bundle.Slices for entry.entry:serviceRequest.resource.intent This element is a modifier element. This element is included in summaries. 1..1 code order | reflex-order
Binding: RequestIntent (required): The kind of service request.
Fixed Value: order (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.category This element is included in summaries. 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (required): Classification of the requested service.
Bundle.Slices for entry.entry:serviceRequest.resource.category.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.category.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.category.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Bundle.Slices for entry.entry:serviceRequest.resource.category.coding.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.category.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.category.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.category.coding.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
Fixed Value: 108252007 (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.category.coding.display This element is included in summaries. C 0..1 string Representation defined by the system
Fixed Value: Laboratory procedure (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.category.text This element is included in summaries. 0..1 string Plain text representation of the concept
Fixed Value: Laboratory procedure (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.priority This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
Bundle.Slices for entry.entry:serviceRequest.resource.code This element is included in summaries. C 1..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
Binding: http://loinc.org (preferred): For laboratory codes
Bundle.Slices for entry.entry:serviceRequest.resource.code.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.code.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.code.concept This element is included in summaries. 0..1 CodeableConcept Reference to a concept (by class)
Bundle.Slices for entry.entry:serviceRequest.resource.code.reference This element is included in summaries. 0..1 Reference() Reference to a resource (by instance)
Bundle.Slices for entry.entry:serviceRequest.resource.orderDetail This element is included in summaries. C 0..* BackboneElement Additional order information
Bundle.Slices for entry.entry:serviceRequest.resource.orderDetail.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.orderDetail.parameter This element is included in summaries. 1..* BackboneElement The parameter details for the service being requested
Bundle.Slices for entry.entry:serviceRequest.resource.orderDetail.parameter.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.orderDetail.parameter.code This element is included in summaries. 1..1 CodeableConcept The detail of the order being requested
Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ObservationValue",
      "code" : "LOINC",
      "display" : "Test Code"
    }
  ]
}
Bundle.Slices for entry.entry:serviceRequest.resource.orderDetail.parameter.value[x] This element is included in summaries. 1..1 CodeableConcept The value for the order detail
Binding: http://loinc.org (preferred): LOINC codes for individual laboratory tests
Bundle.Slices for entry.entry:serviceRequest.resource.subject This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
Bundle.Slices for entry.entry:serviceRequest.resource.subject.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.subject.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.subject.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Constraints: subject-identified
Bundle.Slices for entry.entry:serviceRequest.resource.subject.display This element is included in summaries. C 0..1 string Text alternative for the resource
Bundle.Slices for entry.entry:serviceRequest.resource.focus This element is included in summaries. 0..* Reference(Resource) What the service request is about, when it is not about the subject of record
Bundle.Slices for entry.entry:serviceRequest.resource.requester This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
Bundle.Slices for entry.entry:serviceRequest.resource.requester.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.requester.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.requester.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Bundle.Slices for entry.entry:serviceRequest.resource.requester.type This element is included in summaries. 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: Practitioner (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.resource.specimen This element is included in summaries. 1..1 Reference(Specimen) Procedure Samples
Bundle.Slices for entry.entry:serviceRequest.resource.specimen.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.specimen.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.specimen.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Bundle.Slices for entry.entry:serviceRequest.resource.specimen.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Bundle.Slices for entry.entry:serviceRequest.resource.specimen.identifier This element is included in summaries. C 0..1 Identifier Logical reference, when literal reference is not known
Bundle.Slices for entry.entry:serviceRequest.resource.specimen.display This element is included in summaries. C 0..1 string Text alternative for the resource
Bundle.Slices for entry.entry:serviceRequest.resource.bodyStructure This element is included in summaries. C 0..1 Reference(BodyStructure) BodyStructure-based location on the body
Bundle.Slices for entry.entry:serviceRequest.resource.note 0..* Annotation Comments
Bundle.Slices for entry.entry:serviceRequest.resource.note.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.resource.note.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:serviceRequest.resource.note.text This element is included in summaries. 1..1 markdown The annotation - text content (as markdown)
Bundle.Slices for entry.entry:serviceRequest.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:serviceRequest.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:serviceRequest.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:serviceRequest.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:serviceRequest.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:serviceRequest.request.url This element is included in summaries. 1..1 uri "ServiceRequest"
Bundle.Slices for entry.entry:serviceRequest.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache validation
Bundle.Slices for entry.entry:serviceRequest.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:serviceRequest.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:patient This element is included in summaries. C 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:patient.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:patient.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:patient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:patient.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:patient.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:patient.resource C 1..1 SenaitePatient Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Information about an individual or animal receiving health care services
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:patient.resource.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.Slices for entry.entry:patient.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:patient.resource.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Bundle.Slices for entry.entry:patient.resource.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Bundle.Slices for entry.entry:patient.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:patient.resource.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:patient.resource.Slices for extension Content/Rules for all slices
Bundle.Slices for entry.entry:patient.resource.Slices for extension.extension:estimatedDateBirth 0..1 boolean If the date of birth was not known precisely
URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth
Bundle.Slices for entry.entry:patient.resource.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Bundle.Slices for entry.entry:patient.resource.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:use
Bundle.Slices for entry.entry:patient.resource.Slices for identifier Content/Rules for all slices
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Patient ID — server-assigned, do not include on create
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Internal Patient ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/patient-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE patient identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn This element is included in summaries. 0..1 Identifier External Patient ID from the consumer's system — may be supplied on create
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.system This element is included in summaries. 1..1 uri External Patient ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/patient-mrn
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:patient.resource.Slices for identifier.identifier:mrn.value This element is included in summaries. C 1..1 string External patient identifier, typically an MRN — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:patient.resource.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Bundle.Slices for entry.entry:patient.resource.name This element is included in summaries. 1..* HumanName A name associated with the patient
Bundle.Slices for entry.entry:patient.resource.name.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:patient.resource.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:patient.resource.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Bundle.Slices for entry.entry:patient.resource.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Bundle.Slices for entry.entry:patient.resource.name.given This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Bundle.Slices for entry.entry:patient.resource.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Bundle.Slices for entry.entry:patient.resource.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Bundle.Slices for entry.entry:patient.resource.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Bundle.Slices for entry.entry:patient.resource.telecom.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:patient.resource.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:patient.resource.telecom.system This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Bundle.Slices for entry.entry:patient.resource.telecom.value This element is included in summaries. C 0..1 string The actual contact point details
Bundle.Slices for entry.entry:patient.resource.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Bundle.Slices for entry.entry:patient.resource.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Bundle.Slices for entry.entry:patient.resource.gender This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Bundle.Slices for entry.entry:patient.resource.birthDate This element is included in summaries. 1..1 date The date of birth for the individual
Bundle.Slices for entry.entry:patient.resource.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 dateTime Indicates if the individual is deceased or not
Bundle.Slices for entry.entry:patient.resource.address This element is included in summaries. 0..* Address An address for the individual
Bundle.Slices for entry.entry:patient.resource.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (required): The domestic partnership status of a person.
Bundle.Slices for entry.entry:patient.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:patient.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:patient.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:patient.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:patient.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:patient.request.url This element is included in summaries. 1..1 uri "Patient"
Bundle.Slices for entry.entry:patient.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache validation
Bundle.Slices for entry.entry:patient.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:patient.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:patient.request.ifNoneExist This element is included in summaries. C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.Slices for entry.entry:practitioner This element is included in summaries. C 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:practitioner.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:practitioner.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:practitioner.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:practitioner.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:practitioner.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:practitioner.resource C 1..1 SenaitePractitioner Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:practitioner.resource.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.Slices for entry.entry:practitioner.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:practitioner.resource.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Bundle.Slices for entry.entry:practitioner.resource.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Bundle.Slices for entry.entry:practitioner.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for the person as this agent
Slice: Unordered, Closed by value:use
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier Content/Rules for all slices
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Practitioner ID — server-assigned, do not include on create
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Internal Practitioner ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/practitioner-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE practitioner identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId This element is included in summaries. 0..1 Identifier External Practitioner ID from the consumer's system — may be supplied on create
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.system This element is included in summaries. 1..1 uri External Practitioner ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/practitioner-external-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:practitioner.resource.Slices for identifier.identifier:externalId.value This element is included in summaries. C 1..1 string External practitioner identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:practitioner.resource.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this practitioner's record is in active use
Bundle.Slices for entry.entry:practitioner.resource.name This element is included in summaries. 1..1 HumanName The name(s) associated with the practitioner
Bundle.Slices for entry.entry:practitioner.resource.name.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:practitioner.resource.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:practitioner.resource.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Bundle.Slices for entry.entry:practitioner.resource.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Bundle.Slices for entry.entry:practitioner.resource.name.given This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Bundle.Slices for entry.entry:practitioner.resource.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Bundle.Slices for entry.entry:practitioner.resource.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Bundle.Slices for entry.entry:practitioner.resource.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
Bundle.Slices for entry.entry:practitioner.resource.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Bundle.Slices for entry.entry:practitioner.resource.birthDate This element is included in summaries. 0..1 date The date on which the practitioner was born
Bundle.Slices for entry.entry:practitioner.resource.address This element is included in summaries. 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
Bundle.Slices for entry.entry:practitioner.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:practitioner.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:practitioner.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:practitioner.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:practitioner.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:practitioner.request.url This element is included in summaries. 1..1 uri "Practitioner"
Bundle.Slices for entry.entry:practitioner.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache validation
Bundle.Slices for entry.entry:practitioner.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:practitioner.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:practitioner.request.ifNoneExist This element is included in summaries. C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.Slices for entry.entry:specimen This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:specimen.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:specimen.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:specimen.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:specimen.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:specimen.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:specimen.resource C 1..1 SenaiteSpecimen Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Sample for analysis
Constraints: no-internal-id-on-create, no-barcode-on-create
Bundle.Slices for entry.entry:specimen.resource.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.Slices for entry.entry:specimen.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:specimen.resource.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Bundle.Slices for entry.entry:specimen.resource.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Bundle.Slices for entry.entry:specimen.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:specimen.resource.Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by
Bundle.Slices for entry.entry:specimen.resource.Slices for extension Content/Rules for all slices
Bundle.Slices for entry.entry:specimen.resource.Slices for extension.extension:barcode 0..1 Attachment Barcode label (base64 PDF or image) — SHALL be present when returned by SENAITE; SHALL NOT be supplied on create
URL: https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier This element is included in summaries. 0..* Identifier External Identifier
Slice: Unordered, Closed by value:use
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier Content/Rules for all slices
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Sample ID — matches the DiagnosticReport usual identifier
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed)
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE sample identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId This element is included in summaries. 0..1 Identifier External Client Sample ID assigned by the consumer's system — may be supplied on create
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.system This element is included in summaries. 1..1 uri Client Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/client-sample-id (no extensions allowed)
Bundle.Slices for entry.entry:specimen.resource.Slices for identifier.identifier:clientSampleId.value This element is included in summaries. C 1..1 string Client Sample ID — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:specimen.resource.status This element is a modifier element. This element is included in summaries. 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
Bundle.Slices for entry.entry:specimen.resource.type This element is included in summaries. 1..1 CodeableConcept Kind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.
Bundle.Slices for entry.entry:specimen.resource.type.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:specimen.resource.type.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:specimen.resource.type.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
Binding: http://snomed.info/sct (preferred)
Bundle.Slices for entry.entry:specimen.resource.type.coding.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:specimen.resource.type.coding.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:specimen.resource.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Bundle.Slices for entry.entry:specimen.resource.type.coding.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
Bundle.Slices for entry.entry:specimen.resource.type.coding.display This element is included in summaries. C 0..1 string Representation defined by the system
Bundle.Slices for entry.entry:specimen.resource.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Bundle.Slices for entry.entry:specimen.resource.collection 1..1 BackboneElement Collection details
Bundle.Slices for entry.entry:specimen.resource.collection.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:specimen.resource.collection.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:specimen.resource.collection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:specimen.resource.collection.collector This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who collected the specimen
Bundle.Slices for entry.entry:specimen.resource.collection.collected[x] This element is included in summaries. 0..1 dateTime Collection time
Bundle.Slices for entry.entry:specimen.resource.collection.device 0..1 CodeableReference(Device) Device used to perform collection
Binding Description: (example): The device that was used to obtain the specimen (e.g. a catheter or catheter part used to draw the blood via a central line).
Bundle.Slices for entry.entry:specimen.resource.collection.procedure 0..1 Reference(Procedure) The procedure that collects the specimen
Bundle.Slices for entry.entry:specimen.resource.collection.bodySite 0..1 CodeableReference(BodyStructure) Anatomical collection site
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
Bundle.Slices for entry.entry:specimen.resource.note 0..* Annotation Comments
Bundle.Slices for entry.entry:specimen.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:specimen.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:specimen.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:specimen.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:specimen.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:specimen.request.url This element is included in summaries. 1..1 uri "Specimen"
Bundle.Slices for entry.entry:specimen.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache validation
Bundle.Slices for entry.entry:specimen.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:specimen.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:organization This element is included in summaries. C 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:organization.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:organization.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:organization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:organization.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:organization.fullUrl This element is included in summaries. C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Constraints: urn-uuid
Bundle.Slices for entry.entry:organization.resource C 1..1 SenaiteOrganization Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A grouping of people or organizations with a common purpose
Constraints: no-internal-id-on-create
Bundle.Slices for entry.entry:organization.resource.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.Slices for entry.entry:organization.resource.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Bundle.Slices for entry.entry:organization.resource.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Bundle.Slices for entry.entry:organization.resource.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Bundle.Slices for entry.entry:organization.resource.contained 0..* Resource Contained, inline Resources
Bundle.Slices for entry.entry:organization.resource.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:organization.resource.Slices for identifier This element is included in summaries. C 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Closed by value:use
Bundle.Slices for entry.entry:organization.resource.Slices for identifier Content/Rules for all slices
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId This element is included in summaries. C 0..1 Identifier Internal SENAITE Client ID — server-assigned, do not include on create
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Internal Organization ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/organization-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE client identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId This element is included in summaries. C 0..1 Identifier External Organization ID from the consumer's system — may be supplied on create
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.id 0..1 id Unique id for inter-element referencing
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.system This element is included in summaries. 1..1 uri External Organization ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/organization-external-id
Example General: http://www.acme.com/identifiers/patient
Bundle.Slices for entry.entry:organization.resource.Slices for identifier.identifier:externalId.value This element is included in summaries. C 1..1 string External organisation identifier — alphanumeric and hyphens only
Example General: 123456
Bundle.Slices for entry.entry:organization.resource.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether the organization's record is still in active use
Bundle.Slices for entry.entry:organization.resource.name This element is included in summaries. C 1..1 string Name used for the organization
Bundle.Slices for entry.entry:organization.resource.contact C 0..* ExtendedContactDetail Official contact details for the Organization
Constraints: org-3, org-4
Bundle.Slices for entry.entry:organization.resource.partOf This element is included in summaries. 0..1 Reference(Organization) The organization of which this organization forms a part
Bundle.Slices for entry.entry:organization.request This element is included in summaries. C 1..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:organization.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:organization.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:organization.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:organization.request.method This element is included in summaries. C 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Fixed Value: POST (no extensions allowed)
Bundle.Slices for entry.entry:organization.request.url This element is included in summaries. 1..1 uri "Organization"
Bundle.Slices for entry.entry:organization.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache validation
Bundle.Slices for entry.entry:organization.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:organization.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:organization.request.ifNoneExist This element is included in summaries. C 0..1 string For conditional creates
Constraints: ifnoneexist-on-identifier
Bundle.issues This element is included in summaries. C 0..1 OperationOutcome(5.0.0) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Issues with the Bundle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.type Base required Bundle Type 📍5.0.0 FHIR Std.
Bundle.link.relation Base required Link Relation Types 📍5.0.0 FHIR Std.
Bundle.entry.search.​mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry.request.​method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.status Base required RequestStatus 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.intent Base required RequestIntent 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.category Base required Service Request Category Codes 📦5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.priority Base required RequestPriority 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.code Base preferred http://loinc.org Not State Unknown
Bundle.entry:serviceRequest.​resource.orderDetail.​parameter.code Base example Servicerequest OrderDetail Parameter Code 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.orderDetail.​parameter.value[x] Base preferred http://loinc.org Not State Unknown
Bundle.entry:serviceRequest.​resource.requester.type Base extensible Resource Types 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​resource.specimen.type Base extensible Resource Types 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​search.mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry:serviceRequest.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.identifier:mrn.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.identifier:mrn.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.name.use Base required NameUse 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.telecom.system Base required ContactPointSystem 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.telecom.use Base required ContactPointUse 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.maritalStatus Base required Marital Status Codes 📦5.0.0 FHIR Std.
Bundle.entry:patient.​resource.contact.relationship Base extensible Patient Contact Relationship 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.contact.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:patient.​resource.link.type Base required Link Type 📍5.0.0 FHIR Std.
Bundle.entry:patient.​search.mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry:patient.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.identifier:externalId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.identifier:externalId.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.name.use Base required NameUse 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​resource.qualification.​code Base example hl7VS-degreeLicenseCertificate 📦3.0.0 THO v7.5
Bundle.entry:practitioner.​resource.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​search.mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry:practitioner.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.identifier:clientSampleId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.identifier:clientSampleId.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.status Base required Specimen Status 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.type Base example hl7VS-specimenType 📦3.0.0 THO v7.5
Bundle.entry:specimen.​resource.type.coding Base preferred http://snomed.info/sct Not State Unknown
Bundle.entry:specimen.​resource.feature.type Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.collection.​device Base example Not State Unknown
Bundle.entry:specimen.​resource.collection.​bodySite Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​resource.processing.​method Base example Specimen Processing Method 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​search.mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry:specimen.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:organization.​resource.language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.entry:organization.​resource.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:organization.​resource.identifier:externalId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Bundle.entry:organization.​resource.identifier:externalId.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Bundle.entry:organization.​resource.qualification.​code Base example Not State Unknown
Bundle.entry:organization.​search.mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry:organization.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search (type = 'searchset') or entry.search.empty()
bdl-5 error Bundle.entry, Bundle.entry:serviceRequest, Bundle.entry:patient, Bundle.entry:practitioner, Bundle.entry:specimen, Bundle.entry:organization must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
bdl-8 error Bundle.entry, Bundle.entry:serviceRequest, Bundle.entry:patient, Bundle.entry:practitioner, Bundle.entry:specimen, Bundle.entry:organization fullUrl cannot be a version specific reference fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-13 error Bundle A subscription-notification must have a SubscriptionStatus as the first resource type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
bdl-14 error Bundle entry.request.method PATCH not allowed for history type = 'history' implies entry.request.method != 'PATCH'
bdl-15 error Bundle Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
bdl-16 error Bundle Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
bdl-17 error Bundle Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. type = 'document' implies issues.empty()
bdl-18 error Bundle Self link is required for searchsets. type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
bdl-3a error Bundle For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3b error Bundle For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3c error Bundle For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3d error Bundle For collections of type transaction-response or batch-response, all entries must contain response elements type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ifnoneexist-on-identifier error Bundle.entry:patient.request.ifNoneExist, Bundle.entry:practitioner.request.ifNoneExist, Bundle.entry:organization.request.ifNoneExist ifNoneExist must key on the resource's external (secondary) or internal (usual) identifier, and must include a system: identifier=<system>|<value> $this.matches('^identifier=[^|]+\|[^|]+$')
no-barcode-on-create error Bundle.entry:specimen.resource The barcode label (SenaiteSpecimenBarcode) is generated by SENAITE and must not be supplied on an external create extension.where(url = 'https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode').empty()
no-internal-id-on-create error Bundle.entry:patient.resource, Bundle.entry:practitioner.resource, Bundle.entry:specimen.resource, Bundle.entry:organization.resource The internal identifier (use = usual) is generated by SENAITE and must not be supplied on an external create identifier.where(use = 'usual').empty()
org-3 error Bundle.entry:organization.resource.contact The telecom of an organization can never be of use 'home' telecom.where(use = 'home').empty()
org-4 error Bundle.entry:organization.resource.contact The address of an organization can never be of use 'home' address.where(use = 'home').empty()
sqty-1 error Bundle.entry:specimen.resource.container.specimenQuantity The comparator is not used on a SimpleQuantity comparator.empty()
subject-identified error Bundle.entry:serviceRequest.resource.subject.reference If there is no identifier then it must have a key hasValue() or subject.identifier.count()
urn-uuid error Bundle.entry:serviceRequest.fullUrl, Bundle.entry:patient.fullUrl, Bundle.entry:practitioner.fullUrl, Bundle.entry:specimen.fullUrl, Bundle.entry:organization.fullUrl fullUrl must be a urn:uuid: reference for POST transaction entries matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')

This structure is derived from Bundle

 

Other representations of profile: CSV, Excel, Schematron