0.1.0 - ci-build
0.1.0 - ci-build
Publication Build: This will be filled in by the publication tooling
| Defining URL: | http://fhir.nav.no/StructureDefinition/HopsMessage |
| Version: | 0.1.0 |
| Name: | HopsMessage |
| Status: | Active as of 2021-10-11T22:21:50+00:00 |
| Publisher: | Norwegian Labour and Welfare Administration (NAV) |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://fhir.nav.no/StructureDefinition/HopsMessage
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Bundle
Summary
Mandatory: 4 elements (1 nested mandatory element)
Fixed Value: 1 element
Prohibited: 16 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Bundle | 0..* | Bundle | Contains a collection of resources | |
  id | I | 0..1 | string | Logical id of this artifact valid-uuid: Must be a valid uuid |
 meta | ||||
 id | 0..0 | |||
| profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| security | 0..0 | |||
 tag | 0..0 | |||
| implicitRules | 0..0 | |||
| language | 0..0 | |||
| identifier | 0..0 | |||
| type | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: message | |
| timestamp | 1..1 | instant | When the bundle was assembled | |
| total | 0..0 | |||
| link | 0..0 | |||
 Slices for entry | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource | |
 entry:All Slices | Content/Rules for all slices | |||
  id | 0..0 | |||
 extension | 0..0 | |||
 modifierExtension | 0..0 | |||
| link | 0..0 | |||
| fullUrl | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource | 1..1 | Resource | A resource in the bundle | |
| search | 0..0 | |||
| request | 0..0 | |||
 response | 0..0 | |||
  entry:messageheader | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
  resource | 0..1 | HopsMessageHeader | A resource that describes a message that is exchanged between systems | |
| signature | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | I | 0..* | Bundle | Contains a collection of resources |
 id | ΣI | 0..1 | string | Logical id of this artifact valid-uuid: Must be a valid uuid |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| source | Σ | 0..1 | uri | Identifies where the resource comes from |
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: message |
| timestamp | Σ | 1..1 | instant | When the bundle was assembled |
 Slices for entry | ΣI | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource 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 |
| entry:All Slices | Content/Rules for all slices | |||
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | Σ | 1..1 | Resource | A resource in the bundle |
| entry:messageheader | ΣI | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information 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 | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| link | Σ | 0..* | See link (Bundle) | Links related to this entry |
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | 0..1 | HopsMessageHeader | A resource that describes a message that is exchanged between systems | |
 search | ΣI | 0..1 | BackboneElement | Search related information |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 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: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
| request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency |
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency |
| ifMatch | Σ | 0..1 | string | For managing update contention |
| ifNoneExist | Σ | 0..1 | string | For conditional creates |
 response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status | Σ | 1..1 | string | Status response code (text optional) |
| location | Σ | 0..1 | uri | The location (if the operation returns a location) |
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) |
| lastModified | Σ | 0..1 | instant | Server's date time modified |
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | I | 0..* | Bundle | Contains a collection of resources |
| Documentation for this format | ||||
This structure is derived from Bundle
Summary
Mandatory: 4 elements (1 nested mandatory element)
Fixed Value: 1 element
Prohibited: 16 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | 0..* | Bundle | Contains a collection of resources | |
| id | I | 0..1 | string | Logical id of this artifact valid-uuid: Must be a valid uuid |
| meta | ||||
| id | 0..0 | |||
| profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| security | 0..0 | |||
| tag | 0..0 | |||
| implicitRules | 0..0 | |||
| language | 0..0 | |||
| identifier | 0..0 | |||
| type | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: message | |
| timestamp | 1..1 | instant | When the bundle was assembled | |
| total | 0..0 | |||
| link | 0..0 | |||
| Slices for entry | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource | |
| entry:All Slices | Content/Rules for all slices | |||
| id | 0..0 | |||
| extension | 0..0 | |||
| modifierExtension | 0..0 | |||
| link | 0..0 | |||
| fullUrl | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource | 1..1 | Resource | A resource in the bundle | |
| search | 0..0 | |||
| request | 0..0 | |||
| response | 0..0 | |||
| entry:messageheader | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource | 0..1 | HopsMessageHeader | A resource that describes a message that is exchanged between systems | |
| signature | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | I | 0..* | Bundle | Contains a collection of resources |
| id | ΣI | 0..1 | string | Logical id of this artifact valid-uuid: Must be a valid uuid |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| source | Σ | 0..1 | uri | Identifies where the resource comes from |
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: message |
| timestamp | Σ | 1..1 | instant | When the bundle was assembled |
| Slices for entry | ΣI | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource 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 |
| entry:All Slices | Content/Rules for all slices | |||
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | Σ | 1..1 | Resource | A resource in the bundle |
| entry:messageheader | ΣI | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information 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 | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| link | Σ | 0..* | See link (Bundle) | Links related to this entry |
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | 0..1 | HopsMessageHeader | A resource that describes a message that is exchanged between systems | |
| search | ΣI | 0..1 | BackboneElement | Search related information |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 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: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
| request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency |
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency |
| ifMatch | Σ | 0..1 | string | For managing update contention |
| ifNoneExist | Σ | 0..1 | string | For conditional creates |
| response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status | Σ | 1..1 | string | Status response code (text optional) |
| location | Σ | 0..1 | uri | The location (if the operation returns a location) |
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) |
| lastModified | Σ | 0..1 | instant | Server's date time modified |
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| Bundle.type | required | Fixed Value: message |
| Bundle.entry.search.mode | required | SearchEntryMode |
| Bundle.entry.request.method | required | HTTPVerb |
| Bundle.entry:messageheader.search.mode | required | SearchEntryMode |
| Bundle.entry:messageheader.request.method | required | HTTPVerb |
| Id | Path | Details | Requirements |
| valid-uuid | Bundle.id | Must be a valid uuid : $this.matches('^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$') |