Left: | CH ORF Document (http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-document) |
Right: | CH ORF Document (http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-document) |
Error | StructureDefinition.version | Values for version differ: '3.0.0-ballot' vs '3.0.0-ci-build' |
Information | StructureDefinition.date | Values for date differ: '2024-05-17T06:31:46+00:00' vs '2024-10-15T15:54:56+00:00' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-document | ||
copyright | CC0-1.0 | ||
date | 2024-05-17T06:31:46+00:00 | 2024-10-15T15:54:56+00:00 |
|
description | Profile to set constraints that specify the CH ORF-conformant presentation of a document. The CH ORF exchange format is defined as a document type corresponding to a Bundle resource. | ||
experimental | |||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#CH | ||
kind | resource | ||
name | ChOrfDocument | ||
publisher | HL7 Switzerland | ||
purpose | |||
status | active | ||
title | CH ORF Document | ||
type | Bundle | ||
url | http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-document | ||
version | 3.0.0-ballot | 3.0.0-ci-build |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Bundle | C | 0..* | CHCoreDocument | CH ORF Bundle bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource | C | 0..* | CHCoreDocument | CH ORF Bundle bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource | |||||||||
id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
identifier | SΣ | 1..1 | Identifier | Document Identifier | SΣ | 1..1 | Identifier | Document Identifier | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | |||||||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | Σ | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |||||||||
value | SΣ | 1..1 | string | UUID as Document Identifier Example General: 123456 | SΣ | 1..1 | string | UUID as Document Identifier Example General: 123456 | |||||||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | Σ | 0..1 | Period | Time period when id is/was valid for use | |||||||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||||||
type | SΣ | 1..1 | code | document Binding: ?? (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document | SΣ | 1..1 | code | document Binding: ?? (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document | |||||||||
timestamp | SΣ | 1..1 | instant | Date, the document was created | SΣ | 1..1 | instant | Date, the document was created | |||||||||
total | ΣC | 0..0 | ΣC | 0..0 | |||||||||||||
link | Σ | 0..0 | Σ | 0..0 | |||||||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
relation | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | |||||||||
url | Σ | 1..1 | uri | Reference details for the link | Σ | 1..1 | uri | Reference details for the link | |||||||||
Slices for entry | SΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | SΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | Σ | 0..* | See link (Bundle) | Links related to this entry | |||||||||
fullUrl | ΣC | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID | ΣC | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID | |||||||||
resource | Σ | 0..1 | Resource | A resource in the bundle | Σ | 0..1 | Resource | A resource in the bundle | |||||||||
search | ΣC | 0..1 | BackboneElement | Search related information | ΣC | 0..1 | BackboneElement | Search related information | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: ?? (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: ?? (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||||||
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | |||||||||
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: ?? (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: ?? (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | |||||||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | |||||||||
ifNoneMatch | Σ | 0..1 | string | For managing cache currency | Σ | 0..1 | string | For managing cache currency | |||||||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | Σ | 0..1 | instant | For managing cache currency | |||||||||
ifMatch | Σ | 0..1 | string | For managing update contention | Σ | 0..1 | string | For managing update contention | |||||||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | Σ | 0..1 | string | For conditional creates | |||||||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
status | Σ | 1..1 | string | Status response code (text optional) | Σ | 1..1 | string | Status response code (text optional) | |||||||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) | Σ | 0..1 | uri | The location (if the operation returns a location) | |||||||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | Σ | 0..1 | string | The Etag for the resource (if relevant) | |||||||||
lastModified | Σ | 0..1 | instant | Server's date time modified | Σ | 0..1 | instant | Server's date time modified | |||||||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||||||
signature | Σ | 0..1 | Signature | Digital Signature | Σ | 0..1 | Signature | Digital Signature | |||||||||
Documentation for this format |