3. Razmjena nestrukturiranih dokumenata
Funkcionalnost razmjene nestrukturiranih dokumenata omogućuje pohranu dokumenata čiji sadržaj nije modeliran korištenjem strukturiranih FHIR resursa, već se prenosi kao elektronički dokument u izvornom obliku. Funkcionalnost je namijenjena integraciji vanjskih informacijskih sustava s Podsustavom 1 CEZIH-a radi pohrane, upravljanja i prikaza dokumenata nastalih izvan CEZIH sustava.
Razmjena nestrukturiranih dokumenata implementirana je korištenjem profila za razmjenu vanjskih dokumenata temeljenih na IHE MHD profilu. Dokumenti poslani korištenjem ovog profila ne moraju imati reference na posjete i slučajeve ranije registrirane u Podsustavu 1 CEZIHa.
Dokument se u CEZIH dostavlja zajedno s pripadajućim metapodacima koji omogućuju identifikaciju dokumenta, pacijenta autora te vrste dokumenta kao base64 enkodiran Binary resurs. Dokument i pripadajući metapodaci pohranjuju se u registar i repozitorij kliničkih dokumenata Podsustava 1.
Gx aplikacijama i drugim informacijskim sustavima omogućeno je slanje nestrukturiranih dokumenata korištenjem odgovarajućih sučelja za razmjenu dokumenata. Prilikom zaprimanja dokumenta Podsustav 1 provodi validaciju tehničke ispravnosti poruke, provjeru obaveznih metapodataka te validaciju korištenih terminologija i klasifikacija dokumenata.
Svaki nestrukturirani dokument mora sadržavati podatke potrebne za jednoznačnu identifikaciju:
- pacijenta
- autora dokumenta
- odgovornog zdravstvenog djelatnika, ako je primjenjivo
- zdravstvene ustanove, ako je primjenjivo
- vrste dokumenta
- datuma nastanka dokumenta,
- vrste formata poslanog dokumena (MIME Type).
Pacijent, autor dokumenta i ustanova moraju biti ranije registrirani u Podsustavu 1.
Sadržaj nestrukturiranog dokumenta ne podliježe semantičkoj obradi niti se podaci iz dokumenta izdvajaju u strukturirani oblik unutar CEZIH sustava. CEZIH evidentira dokument kao cjelinu zajedno s pripadajućim metapodacima potrebnim za identifikaciju, pretraživanje i prikaz dokumentacije. Ovo omogućuje pohranu različitih vrsta dokumenata uz zadržavanje izvornog sadržaja dokumenta.
Sve aktivnosti povezane sa slanjem, pohranom i upravljanjem dokumentima evidentiraju se u sustavu audita Podsustava 1 radi osiguravanja sljedivosti i nadzora nad pristupom zdravstvenoj dokumentaciji. Ovisno o vrsti dokumenta, dokument može biti prikazan korisnicima putem odgovarajućih CEZIH aplikacija, uključujući eKarton i Portal zdravlja.
3.1. Sigurnost
Za generiranje i dohvat identifikatora dokumenata potrebno je koristiti sljedeće sigurnosne mehanizme:
- Sigurnost na transportnom sloju
- Autentikacija i autorizacija informacijskog sustava
3.2. Specifikacija profila
| HRExternalMinimalProvideDocumentBundle (Bundle) | C | Bundle | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| versionId | Σ | 0..1 | id |
| lastUpdated | Σ | 0..1 | instant |
| source | Σ | 0..1 | uri |
| profile | Σ | 1..* | canonical(StructureDefinition) |
| security | Σ | 0..* | CodingBinding |
| tag | Σ | 0..* | Coding |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| identifier | Σ | 0..1 | Identifier |
| type | Σ | 1..1 | codeBindingPattern |
| timestamp | Σ | 0..1 | instant |
| total | Σ C | 0..1 | unsignedInt |
| link | Σ | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| relation | Σ | 1..1 | string |
| url | Σ | 1..1 | uri |
| entry | S Σ C | 1..* | BackboneElement |
| (All Slices) | |||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| link | Σ | 0..* | see (link) |
| fullUrl | Σ | 0..1 | uri |
| resource | S Σ | 0..1 | Resource |
| search | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| mode | Σ | 0..1 | codeBinding |
| score | Σ | 0..1 | decimal |
| request | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| method | Σ | 1..1 | codeBinding |
| url | Σ | 1..1 | uri |
| ifNoneMatch | Σ | 0..1 | string |
| ifModifiedSince | Σ | 0..1 | instant |
| ifMatch | Σ | 0..1 | string |
| ifNoneExist | Σ | 0..1 | string |
| response | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| status | Σ | 1..1 | string |
| location | Σ | 0..1 | uri |
| etag | Σ | 0..1 | string |
| lastModified | Σ | 0..1 | instant |
| outcome | Σ | 0..1 | Resource |
| SubmissionSet | Σ C | 1..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| link | Σ | 0..* | see (link) |
| fullUrl | Σ | 0..1 | uri |
| resource | S Σ C | 1..1 | HRExternalMinimalSubmissionSet |
| search | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| mode | Σ | 0..1 | codeBinding |
| score | Σ | 0..1 | decimal |
| request | Σ C | 1..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| method | Σ | 1..1 | codeBindingPattern |
| url | Σ | 1..1 | uri |
| ifNoneMatch | Σ | 0..1 | string |
| ifModifiedSince | Σ | 0..1 | instant |
| ifMatch | Σ | 0..1 | string |
| ifNoneExist | Σ | 0..1 | string |
| response | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| status | Σ | 1..1 | string |
| location | Σ | 0..1 | uri |
| etag | Σ | 0..1 | string |
| lastModified | Σ | 0..1 | instant |
| outcome | Σ | 0..1 | Resource |
| DocumentRefs | Σ C | 1..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| link | Σ | 0..* | see (link) |
| fullUrl | Σ | 0..1 | uri |
| resource | S Σ C | 1..1 | HRExternalMinimalDocumentReference |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| modifierExtension | ?! C | 0..* | Extension |
| masterIdentifier | Σ | 1..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBindingPattern |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 1..1 | uri |
| value | Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| identifier | S Σ | 1..* | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBindingPattern |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 1..1 | uriFixed Value |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| status | Σ ?! | 1..1 | codeBinding |
| docStatus | Σ | 0..1 | codeBinding |
| type | S Σ | 1..1 | CodeableConceptBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 1..1 | Coding |
| text | Σ | 1..1 | string |
| category | S Σ | 0..* | CodeableConcept |
| subject | Σ C | 1..1 | Reference(HRPatient) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 1..1 | uriBindingFixed Value |
| identifier | Σ | 1..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 1..1 | uri |
| value | Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| display | Σ | 0..1 | string |
| date | Σ | 1..1 | instant |
| author | Σ C | 1..* | Reference(HROrganizacija | HRPatient | HRPractitioner | Device) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 1..1 | uriBinding |
| identifier | Σ | 1..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 1..1 | uri |
| value | Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| display | Σ | 0..1 | string |
| authenticator | C | 0..1 | Reference(HRPatient | HRPractitioner) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 1..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 1..1 | uri |
| value | Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| display | Σ | 0..1 | string |
| custodian | C | 1..1 | Reference(HROrganizacija) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| display | Σ | 1..1 | string |
| relatesTo | Σ | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| code | Σ | 1..1 | codeBinding |
| target | Σ C | 1..1 | Reference(DocumentReference) |
| description | Σ | 0..1 | string |
| securityLabel | Σ | 0..* | CodeableConceptBinding |
| content | Σ | 1..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| attachment | Σ C | 1..1 | Attachment |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| contentType | Σ | 1..1 | codeBinding |
| language | Σ | 0..1 | codeBinding |
| data | 0..0 | base64Binary | |
| url | Σ | 1..1 | url |
| size | Σ | 0..1 | unsignedInt |
| hash | Σ | 0..1 | base64Binary |
| title | Σ | 0..1 | string |
| creation | Σ | 0..1 | dateTime |
| format | Σ | 0..1 | CodingBinding |
| context | Σ | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| encounter | C | 0..* | Reference(Encounter | EpisodeOfCare) |
| event | 0..* | CodeableConcept | |
| period | Σ C | 0..1 | Period |
| facilityType | 0..1 | CodeableConcept | |
| practiceSetting | 0..1 | CodeableConcept | |
| sourcePatientInfo | C | 0..1 | Reference(Patient) |
| related | C | 0..* | Reference(Resource) |
| search | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| mode | Σ | 0..1 | codeBinding |
| score | Σ | 0..1 | decimal |
| request | Σ C | 1..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| method | Σ | 1..1 | codeBindingPattern |
| url | Σ | 1..1 | uri |
| ifNoneMatch | Σ | 0..1 | string |
| ifModifiedSince | Σ | 0..1 | instant |
| ifMatch | Σ | 0..1 | string |
| ifNoneExist | Σ | 0..1 | string |
| response | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| status | Σ | 1..1 | string |
| location | Σ | 0..1 | uri |
| etag | Σ | 0..1 | string |
| lastModified | Σ | 0..1 | instant |
| outcome | Σ | 0..1 | Resource |
| Documents | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| link | Σ | 0..* | see (link) |
| fullUrl | Σ | 0..1 | uri |
| resource | S Σ | 1..1 | Binary |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| contentType | Σ | 1..1 | codeBinding |
| securityContext | Σ C | 0..1 | Reference(Resource) |
| data | 1..1 | base64Binary | |
| search | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| mode | Σ | 0..1 | codeBinding |
| score | Σ | 0..1 | decimal |
| request | Σ C | 1..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| method | Σ | 1..1 | codeBindingPattern |
| url | Σ | 1..1 | uri |
| ifNoneMatch | Σ | 0..1 | string |
| ifModifiedSince | Σ | 0..1 | instant |
| ifMatch | Σ | 0..1 | string |
| ifNoneExist | Σ | 0..1 | string |
| response | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| status | Σ | 1..1 | string |
| location | Σ | 0..1 | uri |
| etag | Σ | 0..1 | string |
| lastModified | Σ | 0..1 | instant |
| outcome | Σ | 0..1 | Resource |
| FhirDocuments | Σ C | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| link | Σ | 0..* | see (link) |
| fullUrl | Σ | 0..1 | uri |
| resource | S Σ C | 1..1 | Bundle |
| search | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| mode | Σ | 0..1 | codeBinding |
| score | Σ | 0..1 | decimal |
| request | Σ C | 1..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| method | Σ | 1..1 | codeBindingPattern |
| url | Σ | 1..1 | uri |
| ifNoneMatch | Σ | 0..1 | string |
| ifModifiedSince | Σ | 0..1 | instant |
| ifMatch | Σ | 0..1 | string |
| ifNoneExist | Σ | 0..1 | string |
| response | Σ C | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| status | Σ | 1..1 | string |
| location | Σ | 0..1 | uri |
| etag | Σ | 0..1 | string |
| lastModified | Σ | 0..1 | instant |
| outcome | Σ | 0..1 | Resource |
| Folders | Σ C | 0..0 | BackboneElement |
| Patient | Σ C | 0..0 | BackboneElement |
| signature | Σ | 0..1 | Signature |
| Bundle | |||
| Short | Contains a collection of resources | ||
| Definition | A container for a collection of resources. | ||
| Cardinality | 0..* | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.id | |||
| Short | Logical id of this artifact | ||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
| Cardinality | 0..1 | ||
| Type | id | ||
| Summary | True | ||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.meta | |||
| Short | Metadata about the resource | ||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.meta.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.meta.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.meta.versionId | |||
| Short | Version specific identifier | ||
| Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||
| Cardinality | 0..1 | ||
| Type | id | ||
| Summary | True | ||
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.meta.lastUpdated | |||
| Short | When the resource version last changed | ||
| Definition | When the resource last changed - e.g. when the version changed. | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.meta.source | |||
| Short | Identifies where the resource comes from | ||
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.meta.profile | |||
| Short | Profiles this resource claims to conform to | ||
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||
| Cardinality | 1..* | ||
| Type | canonical(StructureDefinition) | ||
| Summary | True | ||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.meta.security | |||
| Short | Security Labels applied to this resource | ||
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||
| Cardinality | 0..* | ||
| Type | Coding | ||
| Binding | Security Labels from the Healthcare Privacy and Security Classification System. | ||
| Summary | True | ||
| Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.meta.tag | |||
| Short | Tags applied to this resource | ||
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||
| Cardinality | 0..* | ||
| Type | Coding | ||
| Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||
| Summary | True | ||
| Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Modifier | True | ||
| Summary | True | ||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.identifier | |||
| Short | Persistent identifier for the bundle | ||
| Definition | A persistent identifier for the bundle that won't change as a bundle is copied from server to server. | ||
| Cardinality | 0..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| Comments | Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.type | |||
| Short | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | ||
| Definition | Indicates the purpose of this bundle - how it is intended to be used. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | Indicates the purpose of a bundle - how it is intended to be used. | ||
| Summary | True | ||
| Comments | It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | transaction | ||
| Mappings |
| ||
| Bundle.timestamp | |||
| Short | When the bundle was assembled | ||
| Definition | The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated. Usage:
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.total | |||
| Short | If search, the total number of matches | ||
| Definition | If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. | ||
| Cardinality | 0..1 | ||
| Type | unsignedInt | ||
| Summary | True | ||
| Comments | Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.link | |||
| Short | Links related to this Bundle | ||
| Definition | A series of links that provide context to this bundle. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Comments | Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS). Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly. This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.link.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.link.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.link.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.link.relation | |||
| Short | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||
| Definition | A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.link.url | |||
| Short | Reference details for the link | ||
| Definition | The reference details for the link. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry | |||
| Short | Entry in the bundle - will have a resource or information | ||
| Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). | ||
| Cardinality | 1..* | ||
| Type | BackboneElement | ||
| Must Support | True | ||
| Summary | True | ||
| Slicing | Unordered, Closed, by resource(Profile), request.method(Value) Slicing based on the profile conformance of the entry | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.link | |||
| Short | Links related to this entry | ||
| Definition | A series of links that provide context to this entry. | ||
| Cardinality | 0..* | ||
| Type | see (link) | ||
| Summary | True | ||
| Bundle.entry.fullUrl | |||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.resource | |||
| Short | A resource in the bundle | ||
| Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. | ||
| Cardinality | 0..1 | ||
| Type | Resource | ||
| Must Support | True | ||
| Summary | True | ||
| Mappings |
| ||
| Bundle.entry.search | |||
| Short | Search related information | ||
| Definition | Information about the search process that lead to the creation of this entry. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.search.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry.search.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.search.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.search.mode | |||
| Short | match | include | outcome - why this is in the result set | ||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||
| Summary | True | ||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.search.score | |||
| Short | Search ranking (between 0 and 1) | ||
| Definition | When searching, the server's search ranking score for the entry. | ||
| Cardinality | 0..1 | ||
| Type | decimal | ||
| Summary | True | ||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.request | |||
| Short | Additional execution information (transaction/batch/history) | ||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-3 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.request.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry.request.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.request.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.request.method | |||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.request.url | |||
| Short | URL for HTTP equivalent of this entry | ||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.request.ifNoneMatch | |||
| Short | For managing cache currency | ||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.request.ifModifiedSince | |||
| Short | For managing cache currency | ||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.request.ifMatch | |||
| Short | For managing update contention | ||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.request.ifNoneExist | |||
| Short | For conditional creates | ||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.response | |||
| Short | Results of execution (transaction/batch/history) | ||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-4 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.response.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry.response.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.response.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.response.status | |||
| Short | Status response code (text optional) | ||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.response.location | |||
| Short | The location (if the operation returns a location) | ||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.response.etag | |||
| Short | The Etag for the resource (if relevant) | ||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.response.lastModified | |||
| Short | Server's date time modified | ||
| Definition | The date/time that the resource was modified on the server. | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry.response.outcome | |||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||
| Cardinality | 0..1 | ||
| Type | Resource | ||
| Summary | True | ||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet | |||
| Short | the SubmissionSet | ||
| Definition | The SubmissionSet defines who submitted it, why they submitted it, when they submitted, what is in it, and where it is destine. | ||
| Cardinality | 1..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.link | |||
| Short | Links related to this entry | ||
| Definition | A series of links that provide context to this entry. | ||
| Cardinality | 0..* | ||
| Type | see (link) | ||
| Summary | True | ||
| Bundle.entry:SubmissionSet.fullUrl | |||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.resource | |||
| Short | A list is a curated collection of resources | ||
| Definition | A list is a curated collection of resources. | ||
| Cardinality | 1..1 | ||
| Type | HRExternalMinimalSubmissionSet | ||
| Must Support | True | ||
| Summary | True | ||
| Alias | Collection, WorkingList, Organizer | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.search | |||
| Short | Search related information | ||
| Definition | Information about the search process that lead to the creation of this entry. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.search.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.search.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.search.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.search.mode | |||
| Short | match | include | outcome - why this is in the result set | ||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||
| Summary | True | ||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.search.score | |||
| Short | Search ranking (between 0 and 1) | ||
| Definition | When searching, the server's search ranking score for the entry. | ||
| Cardinality | 0..1 | ||
| Type | decimal | ||
| Summary | True | ||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.request | |||
| Short | Additional execution information (transaction/batch/history) | ||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||
| Cardinality | 1..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-3 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.request.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.request.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.request.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.request.method | |||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | POST | ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.request.url | |||
| Short | URL for HTTP equivalent of this entry | ||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.request.ifNoneMatch | |||
| Short | For managing cache currency | ||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.request.ifModifiedSince | |||
| Short | For managing cache currency | ||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.request.ifMatch | |||
| Short | For managing update contention | ||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.request.ifNoneExist | |||
| Short | For conditional creates | ||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.response | |||
| Short | Results of execution (transaction/batch/history) | ||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-4 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.response.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.response.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.response.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.response.status | |||
| Short | Status response code (text optional) | ||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.response.location | |||
| Short | The location (if the operation returns a location) | ||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.response.etag | |||
| Short | The Etag for the resource (if relevant) | ||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.response.lastModified | |||
| Short | Server's date time modified | ||
| Definition | The date/time that the resource was modified on the server. | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:SubmissionSet.response.outcome | |||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||
| Cardinality | 0..1 | ||
| Type | Resource | ||
| Summary | True | ||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs | |||
| Short | the DocumentReference resources | ||
| Definition | DocumentReference resurs sadrži metapodatke poslanog dokumenta: identifikatore, tip dokumenta, podatke o pacijentu za kojeg je poslan dokument, autoru dokumenta, vrijeme slanja... | ||
| Cardinality | 1..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.link | |||
| Short | Links related to this entry | ||
| Definition | A series of links that provide context to this entry. | ||
| Cardinality | 0..* | ||
| Type | see (link) | ||
| Summary | True | ||
| Bundle.entry:DocumentRefs.fullUrl | |||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource | |||
| Short | A reference to a document | ||
| Definition | A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text. | ||
| Cardinality | 1..1 | ||
| Type | HRExternalMinimalDocumentReference | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | Usually, this is used for documents other than those defined by FHIR. | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.id | |||
| Short | Logical id of this artifact | ||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
| Cardinality | 0..1 | ||
| Type | id | ||
| Summary | True | ||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.meta | |||
| Short | Metadata about the resource | ||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Modifier | True | ||
| Summary | True | ||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||
| Cardinality | 0..1 | ||
| Type | Narrative | ||
| Alias | narrative, html, xhtml, display | ||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.contained | |||
| Short | Contained, inline Resources | ||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||
| Cardinality | 0..* | ||
| Type | Resource | ||
| Alias | inline resources, anonymous resources, contained resources | ||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Alias | extensions, user content | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.masterIdentifier | |||
| Short | Identifikator dokumenta. | ||
| Definition | Glavni identifikator dokumenta. Za generiranje identifikatora potrebno je koristiti uslugu Registra identifikatora. Identifikato je u obliku OIDa. | ||
| Cardinality | 1..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| Requirements | The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form "oid^extension", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.). | ||
| Comments | CDA Document Id extension and root. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.masterIdentifier.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.masterIdentifier.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.masterIdentifier.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| Modifier | True | ||
| Summary | True | ||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | usual | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.masterIdentifier.type | |||
| Short | Description of identifier | ||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Summary | True | ||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.masterIdentifier.system | |||
| Short | The namespace for the identifier value | ||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
| Comments | Identifier.system is always case sensitive. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.masterIdentifier.value | |||
| Short | The value that is unique | ||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.masterIdentifier.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.masterIdentifier.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| Definition | Organization that issued/manages the identifier. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization) | ||
| Summary | True | ||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.identifier | |||
| Short | Drugi identifikatori dokumenta. | ||
| Definition | Drugi identifikatori dokumenta. Obavezno je poslati jedan identifikator u obliku UUIDa. | ||
| Cardinality | 1..* | ||
| Type | Identifier | ||
| Must Support | True | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.identifier.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.identifier.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.identifier.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| Modifier | True | ||
| Summary | True | ||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | official | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.identifier.type | |||
| Short | Description of identifier | ||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Summary | True | ||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.identifier.system | |||
| Short | The namespace for the identifier value | ||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
| Comments | Identifier.system is always case sensitive. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | urn:ietf:rfc:3986 | ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.identifier.value | |||
| Short | The value that is unique | ||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.identifier.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.identifier.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| Definition | Organization that issued/manages the identifier. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization) | ||
| Summary | True | ||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.status | |||
| Short | current | superseded | entered-in-error | ||
| Definition | Status dokumenta. Dozvoljene vrijednosti su current | superseded | entered-in-error. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | The status of the document reference. | ||
| Modifier | True | ||
| Summary | True | ||
| Comments | This is the status of the DocumentReference object, which might be independent from the docStatus element. This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.docStatus | |||
| Short | preliminary | final | amended | entered-in-error | ||
| Definition | The status of the underlying document. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Status of the underlying document. | ||
| Summary | True | ||
| Comments | The document that is pointed to might be in various lifecycle states. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.type | |||
| Short | Vrsta dokumenta | ||
| Definition | Vrsta dokumenta, vrijednost iz kodne liste | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Precise type of clinical document. | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.type.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.type.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.type.coding | |||
| Short | Code defined by a terminology system | ||
| Definition | A reference to a code defined by a terminology system. | ||
| Cardinality | 1..1 | ||
| Type | Coding | ||
| Summary | True | ||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.type.text | |||
| Short | Naziv dokumenta | ||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.category | |||
| Short | Categorization of document | ||
| Definition | A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | High-level kind of a clinical document at a macro level. | ||
| Must Support | True | ||
| Summary | True | ||
| Alias | claxs | ||
| Comments | Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.subject | |||
| Short | Pacijent. | ||
| Definition | Veza na resurs pacijenta čije se zdravstvene informacije dokumentiraju. | ||
| Cardinality | 1..1 | ||
| Type | Reference(HRPatient) | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.subject.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.subject.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.subject.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.subject.type | |||
| Short | Tip resursa. | ||
| Definition | Tip resursa na koji pokazuje referenca. U ovom slučaju je fiksna vrijednost Patient. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
| Summary | True | ||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | Patient | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.subject.identifier | |||
| Short | Identifikator pacijenta. | ||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||
| Cardinality | 1..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.subject.identifier.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.subject.identifier.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.subject.identifier.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| Modifier | True | ||
| Summary | True | ||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.subject.identifier.type | |||
| Short | Description of identifier | ||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Summary | True | ||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.subject.identifier.system | |||
| Short | URI identifikatora | ||
| Definition | URL koji definira vrstu identifikatora. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
| Comments | Identifier.system is always case sensitive. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.subject.identifier.value | |||
| Short | Vrijednost identifikatora | ||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.subject.identifier.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.subject.identifier.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| Definition | Organization that issued/manages the identifier. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization) | ||
| Summary | True | ||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.subject.display | |||
| Short | Ime i prezime pacijenta u trenutku slanja dokumenta. | ||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.date | |||
| Short | Datum kreiranja dokumenta | ||
| Definition | Datum kreiranja dokumenta. Koristi se za pretraživanje po datumu. | ||
| Cardinality | 1..1 | ||
| Type | instant | ||
| Summary | True | ||
| Alias | indexed | ||
| Comments | Referencing/indexing time is used for tracking, organizing versions and searching. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.author | |||
| Short | Autor dokumenta | ||
| Definition | Autor dokumenta. Autor dokumenta. Dokument za pacijenta može poslati sam pacijent, zdravstveni djelatnik, zdravstvena organizacija ili uređaj/informacijski sustav. | ||
| Cardinality | 1..* | ||
| Type | Reference(HROrganizacija | HRPatient | HRPractitioner | Device) | ||
| Summary | True | ||
| Comments | Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.author.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.author.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.author.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.author.type | |||
| Short | Vrsta FHIR resursa koji definira autora dokumenta (e.g. "Patient") | ||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
| Summary | True | ||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.author.identifier | |||
| Short | Identifikator autora dokumenta. | ||
| Definition | Identifikator autora dokumenta. Koristi se logička referenca (https://hl7.org/fhir/R4/references.html#logical). | ||
| Cardinality | 1..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.author.identifier.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.author.identifier.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.author.identifier.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| Modifier | True | ||
| Summary | True | ||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.author.identifier.type | |||
| Short | Description of identifier | ||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Summary | True | ||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.author.identifier.system | |||
| Short | The namespace for the identifier value | ||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
| Comments | Identifier.system is always case sensitive. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.author.identifier.value | |||
| Short | The value that is unique | ||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.author.identifier.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.author.identifier.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| Definition | Organization that issued/manages the identifier. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization) | ||
| Summary | True | ||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.author.display | |||
| Short | Text alternative for the resource | ||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.authenticator | |||
| Short | Potpisnik dokumenta | ||
| Definition | Potpisnik dokumenta, u slučaju kada je dokument digitalno potpisan. | ||
| Cardinality | 0..1 | ||
| Type | Reference(HRPatient | HRPractitioner) | ||
| Comments | Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.authenticator.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.authenticator.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.authenticator.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.authenticator.type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
| Summary | True | ||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.authenticator.identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||
| Cardinality | 1..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.authenticator.identifier.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.authenticator.identifier.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.authenticator.identifier.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| Modifier | True | ||
| Summary | True | ||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.authenticator.identifier.type | |||
| Short | Description of identifier | ||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Summary | True | ||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.authenticator.identifier.system | |||
| Short | The namespace for the identifier value | ||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
| Comments | Identifier.system is always case sensitive. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.authenticator.identifier.value | |||
| Short | The value that is unique | ||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.authenticator.identifier.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.authenticator.identifier.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| Definition | Organization that issued/manages the identifier. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization) | ||
| Summary | True | ||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.authenticator.display | |||
| Short | Text alternative for the resource | ||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.custodian | |||
| Short | Organizacija u kojoj je nastao dokument. | ||
| Definition | Identifies the organization or group who is responsible for ongoing maintenance of and access to the document. | ||
| Cardinality | 1..1 | ||
| Type | Reference(HROrganizacija) | ||
| Comments | Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.custodian.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.custodian.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.custodian.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.custodian.type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
| Summary | True | ||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.custodian.identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||
| Cardinality | 0..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.custodian.display | |||
| Short | Naziv organizacije | ||
| Definition | Naziv zdravstvene organizacije u kojoj je nastao dokument. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.relatesTo | |||
| Short | Relationships to other documents | ||
| Definition | Relationships that this document has with other document references that already exist. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Comments | This element is labeled as a modifier because documents that append to other documents are incomplete on their own. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.relatesTo.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.relatesTo.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.relatesTo.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.relatesTo.code | |||
| Short | replaces | transforms | signs | appends | ||
| Definition | The type of relationship that this document has with anther document. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | The type of relationship between documents. | ||
| Summary | True | ||
| Comments | If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.relatesTo.target | |||
| Short | Target of the relationship | ||
| Definition | The target document of this relationship. | ||
| Cardinality | 1..1 | ||
| Type | Reference(DocumentReference) | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.description | |||
| Short | Human-readable description | ||
| Definition | Human-readable description of the source document. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Requirements | Helps humans to assess whether the document is of interest. | ||
| Comments | What the document is about, a terse summary of the document. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.securityLabel | |||
| Short | Document security-tags | ||
| Definition | A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | Security Labels from the Healthcare Privacy and Security Classification System. | ||
| Summary | True | ||
| Requirements | Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended. | ||
| Comments | The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.content | |||
| Short | Document referenced | ||
| Definition | The document and format referenced. There may be multiple content element repetitions, each with a different format. | ||
| Cardinality | 1..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.content.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.content.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.content.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.content.attachment | |||
| Short | Where to access the document | ||
| Definition | The document or URL of the document along with critical metadata to prove content has integrity. | ||
| Cardinality | 1..1 | ||
| Type | Attachment | ||
| Summary | True | ||
| Comments | When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.content.attachment.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.content.attachment.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.content.attachment.contentType | |||
| Short | Mime type of the content, with charset etc. | ||
| Definition | Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | The mime type of an attachment. Any valid mime type is allowed. | ||
| Summary | True | ||
| Requirements | Processors of the data need to be able to know how to interpret the data. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | Generaltext/plain; charset=UTF-8, image/png | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.content.attachment.language | |||
| Short | Human language of the content (BCP-47) | ||
| Definition | The human language of the content. The value can be any valid value according to BCP 47. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| Summary | True | ||
| Requirements | Users need to be able to choose between the languages in a set of attachments. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | Generalen-AU | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.content.attachment.data | |||
| Short | Data inline, base64ed | ||
| Definition | The actual data of the attachment - a sequence of bytes, base64 encoded. | ||
| Cardinality | 0..0 | ||
| Type | base64Binary | ||
| Requirements | The data needs to able to be transmitted inline. | ||
| Comments | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.content.attachment.url | |||
| Short | Uri where the data can be found | ||
| Definition | A location where the data can be accessed. | ||
| Cardinality | 1..1 | ||
| Type | url | ||
| Summary | True | ||
| Requirements | The data needs to be transmitted by reference. | ||
| Comments | If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | Generalhttp://www.acme.com/logo-small.png | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.content.attachment.size | |||
| Short | Number of bytes of content (if url provided) | ||
| Definition | The number of bytes of data that make up this attachment (before base64 encoding, if that is done). | ||
| Cardinality | 0..1 | ||
| Type | unsignedInt | ||
| Summary | True | ||
| Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. | ||
| Comments | The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.content.attachment.hash | |||
| Short | Hash of the data (sha-1, base64ed) | ||
| Definition | The calculated hash of the data using SHA-1. Represented using base64. | ||
| Cardinality | 0..1 | ||
| Type | base64Binary | ||
| Summary | True | ||
| Requirements | Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version). | ||
| Comments | The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.content.attachment.title | |||
| Short | Label to display in place of the data | ||
| Definition | A label or set of text to display in place of the data. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Requirements | Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | GeneralOfficial Corporate Logo | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.content.attachment.creation | |||
| Short | Date attachment was first created | ||
| Definition | The date that the attachment was first created. | ||
| Cardinality | 0..1 | ||
| Type | dateTime | ||
| Summary | True | ||
| Requirements | This is often tracked as an integrity issue for use of the attachment. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.content.format | |||
| Short | Format/content rules for the document | ||
| Definition | An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. | ||
| Cardinality | 0..1 | ||
| Type | Coding | ||
| Binding | Document Format Codes. | ||
| Summary | True | ||
| Comments | Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.context | |||
| Short | Clinical context of document | ||
| Definition | The clinical context in which the document was prepared. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Comments | These values are primarily added to help with searching for interesting/relevant documents. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.context.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.context.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.context.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.context.encounter | |||
| Short | Context of the document content | ||
| Definition | Describes the clinical encounter or type of care that the document content is associated with. | ||
| Cardinality | 0..* | ||
| Type | Reference(Encounter | EpisodeOfCare) | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.context.event | |||
| Short | Main clinical acts documented | ||
| Definition | This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | This list of codes represents the main clinical acts being documented. | ||
| Comments | An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.context.period | |||
| Short | Time of service that is being documented | ||
| Definition | The time period over which the service that is described by the document was provided. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.context.facilityType | |||
| Short | Kind of facility where patient was seen | ||
| Definition | The kind of facility where the patient was seen. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | XDS Facility Type. | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.context.practiceSetting | |||
| Short | Additional details about where the content was created (e.g. clinical specialty) | ||
| Definition | This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | Additional details about where the content was created (e.g. clinical specialty). | ||
| Requirements | This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content. | ||
| Comments | This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.context.sourcePatientInfo | |||
| Short | Patient demographics from source | ||
| Definition | The Patient Information as known when the document was published. May be a reference to a version specific, or contained. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Patient) | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.resource.context.related | |||
| Short | Related identifiers or resources | ||
| Definition | Related identifiers or resources associated with the DocumentReference. | ||
| Cardinality | 0..* | ||
| Type | Reference(Resource) | ||
| Comments | May be identifiers or resources that caused the DocumentReference or referenced Document to be created. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.search | |||
| Short | Search related information | ||
| Definition | Information about the search process that lead to the creation of this entry. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.search.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.search.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.search.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.search.mode | |||
| Short | match | include | outcome - why this is in the result set | ||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||
| Summary | True | ||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.search.score | |||
| Short | Search ranking (between 0 and 1) | ||
| Definition | When searching, the server's search ranking score for the entry. | ||
| Cardinality | 0..1 | ||
| Type | decimal | ||
| Summary | True | ||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.request | |||
| Short | Additional execution information (transaction/batch/history) | ||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||
| Cardinality | 1..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-3 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.request.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.request.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.request.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.request.method | |||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | POST | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.request.url | |||
| Short | URL for HTTP equivalent of this entry | ||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.request.ifNoneMatch | |||
| Short | For managing cache currency | ||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.request.ifModifiedSince | |||
| Short | For managing cache currency | ||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.request.ifMatch | |||
| Short | For managing update contention | ||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.request.ifNoneExist | |||
| Short | For conditional creates | ||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.response | |||
| Short | Results of execution (transaction/batch/history) | ||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-4 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.response.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.response.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.response.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.response.status | |||
| Short | Status response code (text optional) | ||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.response.location | |||
| Short | The location (if the operation returns a location) | ||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.response.etag | |||
| Short | The Etag for the resource (if relevant) | ||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.response.lastModified | |||
| Short | Server's date time modified | ||
| Definition | The date/time that the resource was modified on the server. | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:DocumentRefs.response.outcome | |||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||
| Cardinality | 0..1 | ||
| Type | Resource | ||
| Summary | True | ||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||
| Mappings |
| ||
| Bundle.entry:Documents | |||
| Short | the Documents | ||
| Definition | Dokument poslan u Bundleu. Dokument se šalje kao base64 enkodirani sadržaj. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:Documents.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.link | |||
| Short | Links related to this entry | ||
| Definition | A series of links that provide context to this entry. | ||
| Cardinality | 0..* | ||
| Type | see (link) | ||
| Summary | True | ||
| Bundle.entry:Documents.fullUrl | |||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.resource | |||
| Short | Pure binary content defined by a format other than FHIR | ||
| Definition | A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc. | ||
| Cardinality | 1..1 | ||
| Type | Binary | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | Typically, Binary resources are used for handling content such as:
| ||
| Mappings |
| ||
| Bundle.entry:Documents.resource.id | |||
| Short | Logical id of this artifact | ||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
| Cardinality | 0..1 | ||
| Type | id | ||
| Summary | True | ||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.resource.meta | |||
| Short | Metadata about the resource | ||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.resource.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Modifier | True | ||
| Summary | True | ||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.resource.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.resource.contentType | |||
| Short | MimeType of the binary content | ||
| Definition | MimeType of the binary content represented as a standard MimeType (BCP 13). | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | The mime type of an attachment. Any valid mime type is allowed. | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.resource.securityContext | |||
| Short | Identifies another resource to use as proxy when enforcing access control | ||
| Definition | This element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. Media, DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Resource) | ||
| Summary | True | ||
| Comments | Very often, a server will also know of a resource that references the binary, and can automatically apply the appropriate access rules based on that reference. However, there are some circumstances where this is not appropriate, e.g. the binary is uploaded directly to the server without any linking resource, the binary is referred to from multiple different resources, and/or the binary is content such as an application logo that has less protection than any of the resources that reference it. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.resource.data | |||
| Short | The actual content | ||
| Definition | Base64 enkodirani sadžaj. | ||
| Cardinality | 1..1 | ||
| Type | base64Binary | ||
| Comments | If the content type is itself base64 encoding, then this will be base64 encoded twice - what is created by un-base64ing the content must be the specified content type. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.search | |||
| Short | Search related information | ||
| Definition | Information about the search process that lead to the creation of this entry. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.search.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:Documents.search.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.search.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.search.mode | |||
| Short | match | include | outcome - why this is in the result set | ||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||
| Summary | True | ||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.search.score | |||
| Short | Search ranking (between 0 and 1) | ||
| Definition | When searching, the server's search ranking score for the entry. | ||
| Cardinality | 0..1 | ||
| Type | decimal | ||
| Summary | True | ||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.request | |||
| Short | Additional execution information (transaction/batch/history) | ||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||
| Cardinality | 1..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-3 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.request.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:Documents.request.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.request.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.request.method | |||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | POST | ||
| Mappings |
| ||
| Bundle.entry:Documents.request.url | |||
| Short | URL for HTTP equivalent of this entry | ||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.request.ifNoneMatch | |||
| Short | For managing cache currency | ||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.request.ifModifiedSince | |||
| Short | For managing cache currency | ||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.request.ifMatch | |||
| Short | For managing update contention | ||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.request.ifNoneExist | |||
| Short | For conditional creates | ||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.response | |||
| Short | Results of execution (transaction/batch/history) | ||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-4 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.response.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:Documents.response.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.response.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.response.status | |||
| Short | Status response code (text optional) | ||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.response.location | |||
| Short | The location (if the operation returns a location) | ||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.response.etag | |||
| Short | The Etag for the resource (if relevant) | ||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.response.lastModified | |||
| Short | Server's date time modified | ||
| Definition | The date/time that the resource was modified on the server. | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Documents.response.outcome | |||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||
| Cardinality | 0..1 | ||
| Type | Resource | ||
| Summary | True | ||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments | |||
| Short | the FHIR-FhirDocuments | ||
| Definition | the FHIR-FhirDocuments referenced by the DocumentReference resources | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.link | |||
| Short | Links related to this entry | ||
| Definition | A series of links that provide context to this entry. | ||
| Cardinality | 0..* | ||
| Type | see (link) | ||
| Summary | True | ||
| Bundle.entry:FhirDocuments.fullUrl | |||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.resource | |||
| Short | Contains a collection of resources | ||
| Definition | A container for a collection of resources. | ||
| Cardinality | 1..1 | ||
| Type | Bundle | ||
| Must Support | True | ||
| Summary | True | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.search | |||
| Short | Search related information | ||
| Definition | Information about the search process that lead to the creation of this entry. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.search.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.search.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.search.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.search.mode | |||
| Short | match | include | outcome - why this is in the result set | ||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||
| Summary | True | ||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.search.score | |||
| Short | Search ranking (between 0 and 1) | ||
| Definition | When searching, the server's search ranking score for the entry. | ||
| Cardinality | 0..1 | ||
| Type | decimal | ||
| Summary | True | ||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.request | |||
| Short | Additional execution information (transaction/batch/history) | ||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||
| Cardinality | 1..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-3 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.request.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.request.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.request.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.request.method | |||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | POST | ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.request.url | |||
| Short | URL for HTTP equivalent of this entry | ||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.request.ifNoneMatch | |||
| Short | For managing cache currency | ||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.request.ifModifiedSince | |||
| Short | For managing cache currency | ||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.request.ifMatch | |||
| Short | For managing update contention | ||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.request.ifNoneExist | |||
| Short | For conditional creates | ||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.response | |||
| Short | Results of execution (transaction/batch/history) | ||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-4 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.response.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.response.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.response.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.response.status | |||
| Short | Status response code (text optional) | ||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.response.location | |||
| Short | The location (if the operation returns a location) | ||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.response.etag | |||
| Short | The Etag for the resource (if relevant) | ||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.response.lastModified | |||
| Short | Server's date time modified | ||
| Definition | The date/time that the resource was modified on the server. | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:FhirDocuments.response.outcome | |||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||
| Cardinality | 0..1 | ||
| Type | Resource | ||
| Summary | True | ||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||
| Mappings |
| ||
| Bundle.entry:Folders | |||
| Short | Folders | ||
| Definition | any Folders being created or updated | ||
| Cardinality | 0..0 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:Folders.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.link | |||
| Short | Links related to this entry | ||
| Definition | A series of links that provide context to this entry. | ||
| Cardinality | 0..* | ||
| Type | see (link) | ||
| Summary | True | ||
| Bundle.entry:Folders.fullUrl | |||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.resource | |||
| Short | A list is a curated collection of resources | ||
| Definition | A list is a curated collection of resources. | ||
| Cardinality | 1..1 | ||
| Type | Folder | ||
| Must Support | True | ||
| Summary | True | ||
| Alias | Collection, WorkingList, Organizer | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.search | |||
| Short | Search related information | ||
| Definition | Information about the search process that lead to the creation of this entry. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.search.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:Folders.search.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.search.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.search.mode | |||
| Short | match | include | outcome - why this is in the result set | ||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||
| Summary | True | ||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.search.score | |||
| Short | Search ranking (between 0 and 1) | ||
| Definition | When searching, the server's search ranking score for the entry. | ||
| Cardinality | 0..1 | ||
| Type | decimal | ||
| Summary | True | ||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.request | |||
| Short | Additional execution information (transaction/batch/history) | ||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||
| Cardinality | 1..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-3 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.request.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:Folders.request.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.request.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.request.method | |||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.request.url | |||
| Short | URL for HTTP equivalent of this entry | ||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.request.ifNoneMatch | |||
| Short | For managing cache currency | ||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.request.ifModifiedSince | |||
| Short | For managing cache currency | ||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.request.ifMatch | |||
| Short | For managing update contention | ||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.request.ifNoneExist | |||
| Short | For conditional creates | ||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.response | |||
| Short | Results of execution (transaction/batch/history) | ||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-4 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.response.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:Folders.response.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.response.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.response.status | |||
| Short | Status response code (text optional) | ||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.response.location | |||
| Short | The location (if the operation returns a location) | ||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.response.etag | |||
| Short | The Etag for the resource (if relevant) | ||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.response.lastModified | |||
| Short | Server's date time modified | ||
| Definition | The date/time that the resource was modified on the server. | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Folders.response.outcome | |||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||
| Cardinality | 0..1 | ||
| Type | Resource | ||
| Summary | True | ||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||
| Mappings |
| ||
| Bundle.entry:Patient | |||
| Short | the Patient | ||
| Definition | the Patient | ||
| Cardinality | 0..0 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:Patient.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.link | |||
| Short | Links related to this entry | ||
| Definition | A series of links that provide context to this entry. | ||
| Cardinality | 0..* | ||
| Type | see (link) | ||
| Summary | True | ||
| Bundle.entry:Patient.fullUrl | |||
| Short | URI for resource (Absolute URL server address or URI for UUID/OID) | ||
| Definition | The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
| ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.resource | |||
| Short | Information about an individual or animal receiving health care services | ||
| Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. | ||
| Cardinality | 1..1 | ||
| Type | Patient | ||
| Must Support | True | ||
| Summary | True | ||
| Alias | SubjectOfCare Client Resident | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.search | |||
| Short | Search related information | ||
| Definition | Information about the search process that lead to the creation of this entry. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.search.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:Patient.search.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.search.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.search.mode | |||
| Short | match | include | outcome - why this is in the result set | ||
| Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||
| Summary | True | ||
| Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.search.score | |||
| Short | Search ranking (between 0 and 1) | ||
| Definition | When searching, the server's search ranking score for the entry. | ||
| Cardinality | 0..1 | ||
| Type | decimal | ||
| Summary | True | ||
| Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.request | |||
| Short | Additional execution information (transaction/batch/history) | ||
| Definition | Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-3 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.request.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:Patient.request.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.request.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.request.method | |||
| Short | GET | HEAD | POST | PUT | DELETE | PATCH | ||
| Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.request.url | |||
| Short | URL for HTTP equivalent of this entry | ||
| Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.request.ifNoneMatch | |||
| Short | For managing cache currency | ||
| Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.request.ifModifiedSince | |||
| Short | For managing cache currency | ||
| Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.request.ifMatch | |||
| Short | For managing update contention | ||
| Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.request.ifNoneExist | |||
| Short | For conditional creates | ||
| Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.response | |||
| Short | Results of execution (transaction/batch/history) | ||
| Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, bdl-4 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.response.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Bundle.entry:Patient.response.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.response.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.response.status | |||
| Short | Status response code (text optional) | ||
| Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.response.location | |||
| Short | The location (if the operation returns a location) | ||
| Definition | The location header created by processing this operation, populated if the operation returns a location. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.response.etag | |||
| Short | The Etag for the resource (if relevant) | ||
| Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.response.lastModified | |||
| Short | Server's date time modified | ||
| Definition | The date/time that the resource was modified on the server. | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Bundle.entry:Patient.response.outcome | |||
| Short | OperationOutcome with hints and warnings (for batch/transaction) | ||
| Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||
| Cardinality | 0..1 | ||
| Type | Resource | ||
| Summary | True | ||
| Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||
| Mappings |
| ||
| Bundle.signature | |||
| Short | Digital Signature | ||
| Definition | Digital Signature - base64 encoded. XML-DSig or a JWT. | ||
| Cardinality | 0..1 | ||
| Type | Signature | ||
| Summary | True | ||
| Requirements | A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient. | ||
| Comments | The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||