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
| 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=
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
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 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
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) |
![]() ![]() |
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 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() |
C | 0..1 | Resource | A resource in the bundle |
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
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. |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry | |
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Status response code (text optional) | |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
1..1 | SenaiteServiceRequest |
A request for a service to be performed | |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(SenaiteOrganization) | The submitting client organisation URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | draft | active | on-hold | revoked | entered-in-error Binding: RequestStatus (required): The status of a service order. | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | order | reflex-order Binding: RequestIntent (required): The kind of service request. Fixed Value: order (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (required): Classification of the requested service. | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Fixed Value: Laboratory procedure (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: http://loinc.org (preferred): For laboratory codes |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | |
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL Constraints: subject-identified |
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Specimen) | Procedure Samples | |
![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "ServiceRequest" | |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
C | 1..1 | SenaitePatient |
Information about an individual or animal receiving health care services Constraints: no-internal-id-on-create |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If the date of birth was not known precisely URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:use | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Patient ID — server-assigned, do not include on create | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE patient identifier — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | External Patient ID from the consumer's system — may be supplied on create | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | External patient identifier, typically an MRN — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Whether this patient's record is in active use | |
![]() ![]() ![]() ![]() ![]() |
1..* | HumanName | A name associated with the patient | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |
![]() ![]() ![]() ![]() ![]() |
1..1 | date | The date of birth for the individual | |
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Patient" | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
C | 1..1 | SenaitePractitioner |
A person with a formal responsibility in the provisioning of healthcare or related services Constraints: no-internal-id-on-create |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Closed by value:use | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Practitioner ID — server-assigned, do not include on create | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE practitioner identifier — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | External Practitioner ID from the consumer's system — may be supplied on create | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | External practitioner identifier — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Whether this practitioner's record is in active use | |
![]() ![]() ![]() ![]() ![]() |
1..1 | HumanName | The name(s) associated with the practitioner | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Practitioner" | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
C | 1..1 | SenaiteSpecimen |
Sample for analysis Constraints: no-internal-id-on-create, no-barcode-on-create |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | External Identifier Slice: Unordered, Closed by value:use | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Sample ID — matches the DiagnosticReport usual identifier | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Sample ID namespace — mandatory and fixed by this IG Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE sample identifier — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | External Client Sample ID assigned by the consumer's system — may be supplied on create | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Client Sample ID — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Binding: http://snomed.info/sct (preferred) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Collection details | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Specimen" | |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
C | 1..1 | SenaiteOrganization |
A grouping of people or organizations with a common purpose Constraints: no-internal-id-on-create |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() ![]() ![]() |
C | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Closed by value:use |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Identifier | Internal SENAITE Client ID — server-assigned, do not include on create |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE client identifier — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Identifier | External Organization ID from the consumer's system — may be supplied on create |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | External organisation identifier — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Whether the organization's record is still in active use | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Name used for the organization |
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Organization" | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier |
![]() ![]() |
C | 0..1 | OperationOutcome(5.0.0) |
Issues with the Bundle |
Documentation for this format | ||||
| 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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Bundle | Contains a collection of resources | |
![]() ![]() |
0..0 | Persistent identifier for the bundle | ||
![]() ![]() |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Fixed Value: transaction (no extensions allowed) | |
![]() ![]() |
0..0 | When the bundle was assembled | ||
![]() ![]() |
0..0 | If search, the total number of matches | ||
![]() ![]() |
0..0 | Links related to this Bundle | ||
![]() ![]() |
2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by type:resource | |
![]() ![]() ![]() |
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
1..1 | SenaiteServiceRequest | A request for a service to be performed | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Logical id of this artifact | ||
![]() ![]() ![]() ![]() |
0..0 | Search related information | ||
![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Fixed Value: POST (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "ServiceRequest" | |
![]() ![]() ![]() ![]() ![]() |
0..0 | For conditional creates | ||
![]() ![]() ![]() ![]() |
0..0 | Results of execution (transaction/batch/history) | ||
![]() ![]() ![]() |
0..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
C | 1..1 | SenaitePatient | Information about an individual or animal receiving health care services Constraints: no-internal-id-on-create |
![]() ![]() ![]() ![]() ![]() |
0..0 | Logical id of this artifact | ||
![]() ![]() ![]() ![]() |
0..0 | Search related information | ||
![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Fixed Value: POST (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Patient" | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier |
![]() ![]() ![]() ![]() |
0..0 | Results of execution (transaction/batch/history) | ||
![]() ![]() ![]() |
0..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
C | 1..1 | SenaitePractitioner | A person with a formal responsibility in the provisioning of healthcare or related services Constraints: no-internal-id-on-create |
![]() ![]() ![]() ![]() ![]() |
0..0 | Logical id of this artifact | ||
![]() ![]() ![]() ![]() |
0..0 | Search related information | ||
![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Fixed Value: POST (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Practitioner" | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier |
![]() ![]() ![]() ![]() |
0..0 | Results of execution (transaction/batch/history) | ||
![]() ![]() ![]() |
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
C | 1..1 | SenaiteSpecimen | Sample for analysis Constraints: no-internal-id-on-create, no-barcode-on-create |
![]() ![]() ![]() ![]() ![]() |
0..0 | Logical id of this artifact | ||
![]() ![]() ![]() ![]() |
0..0 | Search related information | ||
![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Fixed Value: POST (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Specimen" | |
![]() ![]() ![]() ![]() ![]() |
0..0 | For conditional creates | ||
![]() ![]() ![]() ![]() |
0..0 | Results of execution (transaction/batch/history) | ||
![]() ![]() ![]() |
0..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
C | 1..1 | SenaiteOrganization | A grouping of people or organizations with a common purpose Constraints: no-internal-id-on-create |
![]() ![]() ![]() ![]() ![]() |
0..0 | Logical id of this artifact | ||
![]() ![]() ![]() ![]() |
0..0 | Search related information | ||
![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Fixed Value: POST (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Organization" | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier |
![]() ![]() ![]() ![]() |
0..0 | Results of execution (transaction/batch/history) | ||
![]() ![]() |
0..0 | Digital Signature | ||
Documentation for this format | ||||
| 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}$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
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 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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) | ||||
![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing cache validation | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | For managing cache currency | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing update contention | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For conditional creates | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Status response code (text optional) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The location (if the operation returns a location) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The Etag for the resource (if relevant) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | Server's date time modified | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid | ||||
![]() ![]() ![]() ![]() |
1..1 | SenaiteServiceRequest |
A request for a service to be performed | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(SenaiteOrganization) | The submitting client organisation URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Order grouping identifier, shared by the ServiceRequests of one multi-tube order | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Requisition value — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | draft | active | on-hold | revoked | entered-in-error Binding: RequestStatus (required): The status of a service order. | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | order | reflex-order Binding: RequestIntent (required): The kind of service request. Fixed Value: order (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (required): Classification of the requested service. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 108252007 (no extensions allowed) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system Fixed Value: Laboratory procedure (no extensions allowed) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Fixed Value: Laboratory procedure (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: http://loinc.org (preferred): For laboratory codes | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Reference to a concept (by class) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference() | Reference to a resource (by instance) | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | Additional order information | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | BackboneElement | The parameter details for the service being requested | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The detail of the order being requested Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters. Required Pattern: | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The value for the order detail Binding: http://loinc.org (preferred): LOINC codes for individual laboratory tests | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL Constraints: subject-identified | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | What the service request is about, when it is not about the subject of record | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Specimen) | Procedure Samples | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Reference(BodyStructure) | BodyStructure-based location on the body | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | Annotation | Comments | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | markdown | The annotation - text content (as markdown) | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "ServiceRequest" | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing cache validation | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | For managing cache currency | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing update contention | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid | ||||
![]() ![]() ![]() ![]() |
C | 1..1 | SenaitePatient |
Information about an individual or animal receiving health care services Constraints: no-internal-id-on-create | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If the date of birth was not known precisely URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:use | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Patient ID — server-assigned, do not include on create | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE patient identifier — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | External Patient ID from the consumer's system — may be supplied on create | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | External patient identifier, typically an MRN — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Whether this patient's record is in active use | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | HumanName | A name associated with the patient | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the individual | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | date | The date of birth for the individual | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Address | An address for the individual | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (required): The domestic partnership status of a person. | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Patient" | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing cache validation | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | For managing cache currency | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing update contention | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid | ||||
![]() ![]() ![]() ![]() |
C | 1..1 | SenaitePractitioner |
A person with a formal responsibility in the provisioning of healthcare or related services Constraints: no-internal-id-on-create | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Closed by value:use | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Practitioner ID — server-assigned, do not include on create | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE practitioner identifier — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | External Practitioner ID from the consumer's system — may be supplied on create | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | External practitioner identifier — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Whether this practitioner's record is in active use | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | HumanName | The name(s) associated with the practitioner | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | date | The date on which the practitioner was born | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Practitioner" | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing cache validation | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | For managing cache currency | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing update contention | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid | ||||
![]() ![]() ![]() ![]() |
C | 1..1 | SenaiteSpecimen |
Sample for analysis Constraints: no-internal-id-on-create, no-barcode-on-create | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Closed by | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | External Identifier Slice: Unordered, Closed by value:use | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Sample ID — matches the DiagnosticReport usual identifier | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Sample ID namespace — mandatory and fixed by this IG Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE sample identifier — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | External Client Sample ID assigned by the consumer's system — may be supplied on create | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Client Sample ID — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Binding: http://snomed.info/sct (preferred) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Collection details | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who collected the specimen | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | Collection time | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Procedure) | The procedure that collects the specimen | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableReference(BodyStructure) | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Annotation | Comments | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Specimen" | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing cache validation | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | For managing cache currency | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing update contention | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid | ||||
![]() ![]() ![]() ![]() |
C | 1..1 | SenaiteOrganization |
A grouping of people or organizations with a common purpose Constraints: no-internal-id-on-create | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Closed by value:use | ||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Identifier | Internal SENAITE Client ID — server-assigned, do not include on create | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE client identifier — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Identifier | External Organization ID from the consumer's system — may be supplied on create | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | External organisation identifier — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Whether the organization's record is still in active use | |||||
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Name used for the organization | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..* | ExtendedContactDetail | Official contact details for the Organization Constraints: org-3, org-4 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | The organization of which this organization forms a part | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Organization" | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing cache validation | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | For managing cache currency | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing update contention | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier | ||||
![]() ![]() |
C | 0..1 | OperationOutcome(5.0.0) |
Issues with the Bundle | ||||
Documentation for this format | ||||||||
| 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. |
| 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
Summary
Mandatory: 8 elements(9 nested mandatory elements)
Fixed: 11 elements
Prohibited: 22 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
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 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
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) |
![]() ![]() |
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 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() |
C | 0..1 | Resource | A resource in the bundle |
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
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. |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry | |
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Status response code (text optional) | |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
1..1 | SenaiteServiceRequest |
A request for a service to be performed | |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(SenaiteOrganization) | The submitting client organisation URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | draft | active | on-hold | revoked | entered-in-error Binding: RequestStatus (required): The status of a service order. | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | order | reflex-order Binding: RequestIntent (required): The kind of service request. Fixed Value: order (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (required): Classification of the requested service. | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Fixed Value: Laboratory procedure (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: http://loinc.org (preferred): For laboratory codes |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | |
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL Constraints: subject-identified |
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Specimen) | Procedure Samples | |
![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "ServiceRequest" | |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
C | 1..1 | SenaitePatient |
Information about an individual or animal receiving health care services Constraints: no-internal-id-on-create |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If the date of birth was not known precisely URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:use | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Patient ID — server-assigned, do not include on create | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE patient identifier — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | External Patient ID from the consumer's system — may be supplied on create | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | External patient identifier, typically an MRN — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Whether this patient's record is in active use | |
![]() ![]() ![]() ![]() ![]() |
1..* | HumanName | A name associated with the patient | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |
![]() ![]() ![]() ![]() ![]() |
1..1 | date | The date of birth for the individual | |
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Patient" | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
C | 1..1 | SenaitePractitioner |
A person with a formal responsibility in the provisioning of healthcare or related services Constraints: no-internal-id-on-create |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Closed by value:use | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Practitioner ID — server-assigned, do not include on create | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE practitioner identifier — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | External Practitioner ID from the consumer's system — may be supplied on create | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | External practitioner identifier — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Whether this practitioner's record is in active use | |
![]() ![]() ![]() ![]() ![]() |
1..1 | HumanName | The name(s) associated with the practitioner | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Practitioner" | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
C | 1..1 | SenaiteSpecimen |
Sample for analysis Constraints: no-internal-id-on-create, no-barcode-on-create |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | External Identifier Slice: Unordered, Closed by value:use | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Sample ID — matches the DiagnosticReport usual identifier | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Sample ID namespace — mandatory and fixed by this IG Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE sample identifier — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | External Client Sample ID assigned by the consumer's system — may be supplied on create | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Client Sample ID — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Binding: http://snomed.info/sct (preferred) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Collection details | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Specimen" | |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
C | 1..1 | SenaiteOrganization |
A grouping of people or organizations with a common purpose Constraints: no-internal-id-on-create |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() ![]() ![]() |
C | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Closed by value:use |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Identifier | Internal SENAITE Client ID — server-assigned, do not include on create |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE client identifier — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Identifier | External Organization ID from the consumer's system — may be supplied on create |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | External organisation identifier — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Whether the organization's record is still in active use | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Name used for the organization |
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Organization" | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier |
![]() ![]() |
C | 0..1 | OperationOutcome(5.0.0) |
Issues with the Bundle |
Documentation for this format | ||||
| 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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Bundle | Contains a collection of resources | |
![]() ![]() |
0..0 | Persistent identifier for the bundle | ||
![]() ![]() |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Fixed Value: transaction (no extensions allowed) | |
![]() ![]() |
0..0 | When the bundle was assembled | ||
![]() ![]() |
0..0 | If search, the total number of matches | ||
![]() ![]() |
0..0 | Links related to this Bundle | ||
![]() ![]() |
2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by type:resource | |
![]() ![]() ![]() |
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
1..1 | SenaiteServiceRequest | A request for a service to be performed | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Logical id of this artifact | ||
![]() ![]() ![]() ![]() |
0..0 | Search related information | ||
![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Fixed Value: POST (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "ServiceRequest" | |
![]() ![]() ![]() ![]() ![]() |
0..0 | For conditional creates | ||
![]() ![]() ![]() ![]() |
0..0 | Results of execution (transaction/batch/history) | ||
![]() ![]() ![]() |
0..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
C | 1..1 | SenaitePatient | Information about an individual or animal receiving health care services Constraints: no-internal-id-on-create |
![]() ![]() ![]() ![]() ![]() |
0..0 | Logical id of this artifact | ||
![]() ![]() ![]() ![]() |
0..0 | Search related information | ||
![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Fixed Value: POST (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Patient" | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier |
![]() ![]() ![]() ![]() |
0..0 | Results of execution (transaction/batch/history) | ||
![]() ![]() ![]() |
0..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
C | 1..1 | SenaitePractitioner | A person with a formal responsibility in the provisioning of healthcare or related services Constraints: no-internal-id-on-create |
![]() ![]() ![]() ![]() ![]() |
0..0 | Logical id of this artifact | ||
![]() ![]() ![]() ![]() |
0..0 | Search related information | ||
![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Fixed Value: POST (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Practitioner" | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier |
![]() ![]() ![]() ![]() |
0..0 | Results of execution (transaction/batch/history) | ||
![]() ![]() ![]() |
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
C | 1..1 | SenaiteSpecimen | Sample for analysis Constraints: no-internal-id-on-create, no-barcode-on-create |
![]() ![]() ![]() ![]() ![]() |
0..0 | Logical id of this artifact | ||
![]() ![]() ![]() ![]() |
0..0 | Search related information | ||
![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Fixed Value: POST (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Specimen" | |
![]() ![]() ![]() ![]() ![]() |
0..0 | For conditional creates | ||
![]() ![]() ![]() ![]() |
0..0 | Results of execution (transaction/batch/history) | ||
![]() ![]() ![]() |
0..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid |
![]() ![]() ![]() ![]() |
C | 1..1 | SenaiteOrganization | A grouping of people or organizations with a common purpose Constraints: no-internal-id-on-create |
![]() ![]() ![]() ![]() ![]() |
0..0 | Logical id of this artifact | ||
![]() ![]() ![]() ![]() |
0..0 | Search related information | ||
![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Fixed Value: POST (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Organization" | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier |
![]() ![]() ![]() ![]() |
0..0 | Results of execution (transaction/batch/history) | ||
![]() ![]() |
0..0 | Digital Signature | ||
Documentation for this format | ||||
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
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 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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) | ||||
![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing cache validation | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | For managing cache currency | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing update contention | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For conditional creates | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Status response code (text optional) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The location (if the operation returns a location) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The Etag for the resource (if relevant) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | Server's date time modified | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid | ||||
![]() ![]() ![]() ![]() |
1..1 | SenaiteServiceRequest |
A request for a service to be performed | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(SenaiteOrganization) | The submitting client organisation URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Order grouping identifier, shared by the ServiceRequests of one multi-tube order | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Requisition value — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | draft | active | on-hold | revoked | entered-in-error Binding: RequestStatus (required): The status of a service order. | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | order | reflex-order Binding: RequestIntent (required): The kind of service request. Fixed Value: order (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (required): Classification of the requested service. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 108252007 (no extensions allowed) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system Fixed Value: Laboratory procedure (no extensions allowed) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Fixed Value: Laboratory procedure (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: http://loinc.org (preferred): For laboratory codes | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Reference to a concept (by class) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference() | Reference to a resource (by instance) | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | Additional order information | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | BackboneElement | The parameter details for the service being requested | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The detail of the order being requested Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters. Required Pattern: | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The value for the order detail Binding: http://loinc.org (preferred): LOINC codes for individual laboratory tests | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL Constraints: subject-identified | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | What the service request is about, when it is not about the subject of record | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Specimen) | Procedure Samples | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Reference(BodyStructure) | BodyStructure-based location on the body | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | Annotation | Comments | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | markdown | The annotation - text content (as markdown) | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "ServiceRequest" | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing cache validation | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | For managing cache currency | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing update contention | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid | ||||
![]() ![]() ![]() ![]() |
C | 1..1 | SenaitePatient |
Information about an individual or animal receiving health care services Constraints: no-internal-id-on-create | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If the date of birth was not known precisely URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:use | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Patient ID — server-assigned, do not include on create | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE patient identifier — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | External Patient ID from the consumer's system — may be supplied on create | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | External patient identifier, typically an MRN — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Whether this patient's record is in active use | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | HumanName | A name associated with the patient | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the individual | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | date | The date of birth for the individual | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Address | An address for the individual | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (required): The domestic partnership status of a person. | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Patient" | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing cache validation | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | For managing cache currency | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing update contention | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid | ||||
![]() ![]() ![]() ![]() |
C | 1..1 | SenaitePractitioner |
A person with a formal responsibility in the provisioning of healthcare or related services Constraints: no-internal-id-on-create | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Closed by value:use | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Practitioner ID — server-assigned, do not include on create | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE practitioner identifier — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | External Practitioner ID from the consumer's system — may be supplied on create | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | External practitioner identifier — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Whether this practitioner's record is in active use | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | HumanName | The name(s) associated with the practitioner | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | date | The date on which the practitioner was born | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Practitioner" | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing cache validation | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | For managing cache currency | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing update contention | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid | ||||
![]() ![]() ![]() ![]() |
C | 1..1 | SenaiteSpecimen |
Sample for analysis Constraints: no-internal-id-on-create, no-barcode-on-create | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Closed by | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | External Identifier Slice: Unordered, Closed by value:use | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Sample ID — matches the DiagnosticReport usual identifier | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Sample ID namespace — mandatory and fixed by this IG Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE sample identifier — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | External Client Sample ID assigned by the consumer's system — may be supplied on create | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Client Sample ID — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Binding: http://snomed.info/sct (preferred) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Collection details | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who collected the specimen | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | Collection time | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Procedure) | The procedure that collects the specimen | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableReference(BodyStructure) | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Annotation | Comments | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Specimen" | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing cache validation | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | For managing cache currency | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing update contention | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: urn-uuid | ||||
![]() ![]() ![]() ![]() |
C | 1..1 | SenaiteOrganization |
A grouping of people or organizations with a common purpose Constraints: no-internal-id-on-create | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Closed by value:use | ||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Identifier | Internal SENAITE Client ID — server-assigned, do not include on create | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE client identifier — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Identifier | External Organization ID from the consumer's system — may be supplied on create | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | External organisation identifier — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Whether the organization's record is still in active use | |||||
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | string | Name used for the organization | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..* | ExtendedContactDetail | Official contact details for the Organization Constraints: org-3, org-4 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | The organization of which this organization forms a part | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "Organization" | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing cache validation | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | For managing cache currency | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing update contention | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | For conditional creates Constraints: ifnoneexist-on-identifier | ||||
![]() ![]() |
C | 0..1 | OperationOutcome(5.0.0) |
Issues with the Bundle | ||||
Documentation for this format | ||||||||
| 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. |
| 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
Summary
Mandatory: 8 elements(9 nested mandatory elements)
Fixed: 11 elements
Prohibited: 22 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron