MedNet interface implementation guide
0.15.0 - CI Build
MedNet interface implementation guide - Local Development build (v0.15.0). See the Directory of published versions
Official URL: https://mednet.swiss/fhir/StructureDefinition/mni-serviceRequest | Version: 0.15.0 | |||
Active as of 2021-02-19 | Computable Name: MNIServiceRequest | |||
Copyright/Legal: novcom AG |
MedNet Interface (MNI) - ServiceRequest Profile
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
Summary
Mandatory: 0 element (5 nested mandatory elements)
Must-Support: 22 elements
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from ServiceRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | 0..* | ServiceRequest | MedNet Interface (MNI) - ServiceRequest | |
id | S | 0..1 | string | The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) |
contained | S | 0..* | Resource | It is possible to include the requester and performer as embedded resource in this contained object. This way it is not needed to include it in the Bundle |
Slices for identifier | S | 0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by pattern:$this |
identifier:orderNr | S | 0..1 | Identifier | The orderNr of the calling system Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
display | 1..1 | string | Representation defined by the system Fixed Value: Medical record number | |
system | S | 0..1 | uri | Uri that defines the Software that delivers the orderNr. If possible this uri should be unique for each order database for example https://mysoftware.ch/orderDB/123456 |
value | S | 1..1 | string | The calling system order number |
status | S | 1..1 | code | Recommended value : active |
intent | S | 1..1 | code | order Fixed Value: order |
priority | S | 0..1 | code | routine | urgent | asap | stat |
code | S | 0..1 | CodeableConcept | Allow specifing the kind of form that should be prefilled by MedNet, like laboratory order, radiologiy order, hospital admission Binding: MedNet Interface (MNI) - ServiceRequest Code ValueSet (extensible) |
Slices for coding | S | 0..* | Coding | Used to categorize the service request type. Could be used to filter the forms proposed by mednet to the user Slice: Unordered, Open by value:system, value:code |
coding:snomed | S | 0..1 | Coding | Code defined by a terminology system |
system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
code | S | 1..1 | code | 721965002 (Laboratory order) | 721964003 (Radiologiy order) | 721964003 (Hospital admission) |
display | S | 0..1 | string | Representation defined by the system |
orderDetail:requestCodes | S | 0..* | CodeableConcept | Allow specifing element codes like laboratory analyse codes that should be preselected in the form |
coding | S | 1..1 | Coding | Allow specifing element codes like laboratory analyse codes that should be preselected in the form |
system | S | 0..1 | uri | Identity of the terminology system Fixed Value: https://mednet.swiss/fhir/serviceRequest/orderDetail |
code | S | 1..1 | code | The element code that should be preselected |
subject | S | 1..1 | Reference(MedNet Interface (MNI) - Patient) | Link to the Patient |
requester | S | 0..1 | Reference(MedNet Interface (MNI) - PractitionerRole) | The MedNet practitioner that request to fill a document. MedNet will link the GLN of the practitionner with its own account id. MedNet will pre-select the account used to fill the document |
performer | S | 0..* | Reference(MedNet Interface (MNI) - PractitionerRole) | The MedNet institution, for which the document should be filled. This can be used to filter the forms proposed by mednet to the user. MedNet will only show the ones of this institution. MedNet will link the GLN of the institution with its own account ids. Multiple performer can be specified |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | I | 0..* | ServiceRequest | MedNet Interface (MNI) - ServiceRequest | ||||
id | SΣ | 0..1 | string | The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | S | 0..* | Resource | It is possible to include the requester and performer as embedded resource in this contained object. This way it is not needed to include it in the Bundle | ||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by pattern:$this | ||||
identifier:orderNr | SΣ | 0..1 | Identifier | The orderNr of the calling system Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Medical record number | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | 0..1 | uri | The namespace for the identifier value | |||||
value | 0..1 | string | The value that is unique | |||||
period | 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) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 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: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 0..1 | uri | Uri that defines the Software that delivers the orderNr. If possible this uri should be unique for each order database for example https://mysoftware.ch/orderDB/123456 Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The calling system order number Example General: 123456 | ||||
period | Σ | 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) | ||||
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||
replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
requisition | Σ | 0..1 | Identifier | Composite Request ID | ||||
status | ?!SΣ | 1..1 | code | Recommended value : active Binding: RequestStatus (required): The status of a service order. | ||||
intent | ?!SΣ | 1..1 | code | order Binding: RequestIntent (required): The kind of service request. Fixed Value: order | ||||
category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
priority | SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
code | SΣ | 0..1 | CodeableConcept | Allow specifing the kind of form that should be prefilled by MedNet, like laboratory order, radiologiy order, hospital admission Binding: MedNet Interface (MNI) - ServiceRequest Code ValueSet (extensible) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | SΣ | 0..* | Coding | Used to categorize the service request type. Could be used to filter the forms proposed by mednet to the user Slice: Unordered, Open by value:system, value:code | ||||
coding:snomed | SΣ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | 721965002 (Laboratory order) | 721964003 (Radiologiy order) | 721964003 (Hospital admission) | ||||
display | SΣ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
orderDetail:requestCodes | SΣI | 0..* | CodeableConcept | Allow specifing element codes like laboratory analyse codes that should be preselected in the form Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | Allow specifing element codes like laboratory analyse codes that should be preselected in the form | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 0..1 | uri | Identity of the terminology system Fixed Value: https://mednet.swiss/fhir/serviceRequest/orderDetail | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | The element code that should be preselected | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
quantity[x] | Σ | 0..1 | Service amount | |||||
quantityQuantity | Quantity | |||||||
quantityRatio | Ratio | |||||||
quantityRange | Range | |||||||
subject | SΣ | 1..1 | Reference(MedNet Interface (MNI) - Patient) | Link to the Patient | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
occurrence[x] | Σ | 0..1 | When service should occur | |||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
asNeeded[x] | Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
asNeededBoolean | boolean | |||||||
asNeededCodeableConcept | CodeableConcept | |||||||
authoredOn | Σ | 0..1 | dateTime | Date request signed | ||||
requester | SΣ | 0..1 | Reference(MedNet Interface (MNI) - PractitionerRole) | The MedNet practitioner that request to fill a document. MedNet will link the GLN of the practitionner with its own account id. MedNet will pre-select the account used to fill the document | ||||
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
performer | SΣ | 0..* | Reference(MedNet Interface (MNI) - PractitionerRole) | The MedNet institution, for which the document should be filled. This can be used to filter the forms proposed by mednet to the user. MedNet will only show the ones of this institution. MedNet will link the GLN of the institution with its own account ids. Multiple performer can be specified | ||||
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
locationReference | Σ | 0..* | Reference(Location) | Requested location | ||||
reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
supportingInfo | 0..* | Reference(Resource) | Additional clinical information | |||||
specimen | Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
note | 0..* | Annotation | Comments | |||||
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | I | 0..* | ServiceRequest | MedNet Interface (MNI) - ServiceRequest |
id | Σ | 0..1 | string | The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) |
contained | 0..* | Resource | It is possible to include the requester and performer as embedded resource in this contained object. This way it is not needed to include it in the Bundle | |
Slices for identifier | Σ | 0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by pattern:$this |
identifier:orderNr | Σ | 0..1 | Identifier | The orderNr of the calling system Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
display | 1..1 | string | Representation defined by the system Fixed Value: Medical record number | |
system | Σ | 0..1 | uri | Uri that defines the Software that delivers the orderNr. If possible this uri should be unique for each order database for example https://mysoftware.ch/orderDB/123456 |
value | Σ | 1..1 | string | The calling system order number |
status | ?!Σ | 1..1 | code | Recommended value : active Binding: RequestStatus (required): The status of a service order. |
intent | ?!Σ | 1..1 | code | order Binding: RequestIntent (required): The kind of service request. Fixed Value: order |
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
code | Σ | 0..1 | CodeableConcept | Allow specifing the kind of form that should be prefilled by MedNet, like laboratory order, radiologiy order, hospital admission Binding: MedNet Interface (MNI) - ServiceRequest Code ValueSet (extensible) |
Slices for coding | Σ | 0..* | Coding | Used to categorize the service request type. Could be used to filter the forms proposed by mednet to the user Slice: Unordered, Open by value:system, value:code |
coding:snomed | Σ | 0..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
code | Σ | 1..1 | code | 721965002 (Laboratory order) | 721964003 (Radiologiy order) | 721964003 (Hospital admission) |
display | Σ | 0..1 | string | Representation defined by the system |
orderDetail:requestCodes | ΣI | 0..* | CodeableConcept | Allow specifing element codes like laboratory analyse codes that should be preselected in the form Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. |
coding | Σ | 1..1 | Coding | Allow specifing element codes like laboratory analyse codes that should be preselected in the form |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://mednet.swiss/fhir/serviceRequest/orderDetail |
code | Σ | 1..1 | code | The element code that should be preselected |
subject | Σ | 1..1 | Reference(MedNet Interface (MNI) - Patient) | Link to the Patient |
requester | Σ | 0..1 | Reference(MedNet Interface (MNI) - PractitionerRole) | The MedNet practitioner that request to fill a document. MedNet will link the GLN of the practitionner with its own account id. MedNet will pre-select the account used to fill the document |
performer | Σ | 0..* | Reference(MedNet Interface (MNI) - PractitionerRole) | The MedNet institution, for which the document should be filled. This can be used to filter the forms proposed by mednet to the user. MedNet will only show the ones of this institution. MedNet will link the GLN of the institution with its own account ids. Multiple performer can be specified |
Documentation for this format |
This structure is derived from ServiceRequest
Summary
Mandatory: 0 element (5 nested mandatory elements)
Must-Support: 22 elements
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ServiceRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | 0..* | ServiceRequest | MedNet Interface (MNI) - ServiceRequest | |
id | S | 0..1 | string | The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) |
contained | S | 0..* | Resource | It is possible to include the requester and performer as embedded resource in this contained object. This way it is not needed to include it in the Bundle |
Slices for identifier | S | 0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by pattern:$this |
identifier:orderNr | S | 0..1 | Identifier | The orderNr of the calling system Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
display | 1..1 | string | Representation defined by the system Fixed Value: Medical record number | |
system | S | 0..1 | uri | Uri that defines the Software that delivers the orderNr. If possible this uri should be unique for each order database for example https://mysoftware.ch/orderDB/123456 |
value | S | 1..1 | string | The calling system order number |
status | S | 1..1 | code | Recommended value : active |
intent | S | 1..1 | code | order Fixed Value: order |
priority | S | 0..1 | code | routine | urgent | asap | stat |
code | S | 0..1 | CodeableConcept | Allow specifing the kind of form that should be prefilled by MedNet, like laboratory order, radiologiy order, hospital admission Binding: MedNet Interface (MNI) - ServiceRequest Code ValueSet (extensible) |
Slices for coding | S | 0..* | Coding | Used to categorize the service request type. Could be used to filter the forms proposed by mednet to the user Slice: Unordered, Open by value:system, value:code |
coding:snomed | S | 0..1 | Coding | Code defined by a terminology system |
system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
code | S | 1..1 | code | 721965002 (Laboratory order) | 721964003 (Radiologiy order) | 721964003 (Hospital admission) |
display | S | 0..1 | string | Representation defined by the system |
orderDetail:requestCodes | S | 0..* | CodeableConcept | Allow specifing element codes like laboratory analyse codes that should be preselected in the form |
coding | S | 1..1 | Coding | Allow specifing element codes like laboratory analyse codes that should be preselected in the form |
system | S | 0..1 | uri | Identity of the terminology system Fixed Value: https://mednet.swiss/fhir/serviceRequest/orderDetail |
code | S | 1..1 | code | The element code that should be preselected |
subject | S | 1..1 | Reference(MedNet Interface (MNI) - Patient) | Link to the Patient |
requester | S | 0..1 | Reference(MedNet Interface (MNI) - PractitionerRole) | The MedNet practitioner that request to fill a document. MedNet will link the GLN of the practitionner with its own account id. MedNet will pre-select the account used to fill the document |
performer | S | 0..* | Reference(MedNet Interface (MNI) - PractitionerRole) | The MedNet institution, for which the document should be filled. This can be used to filter the forms proposed by mednet to the user. MedNet will only show the ones of this institution. MedNet will link the GLN of the institution with its own account ids. Multiple performer can be specified |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | I | 0..* | ServiceRequest | MedNet Interface (MNI) - ServiceRequest | ||||
id | SΣ | 0..1 | string | The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | S | 0..* | Resource | It is possible to include the requester and performer as embedded resource in this contained object. This way it is not needed to include it in the Bundle | ||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by pattern:$this | ||||
identifier:orderNr | SΣ | 0..1 | Identifier | The orderNr of the calling system Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Medical record number | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | 0..1 | uri | The namespace for the identifier value | |||||
value | 0..1 | string | The value that is unique | |||||
period | 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) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 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: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 0..1 | uri | Uri that defines the Software that delivers the orderNr. If possible this uri should be unique for each order database for example https://mysoftware.ch/orderDB/123456 Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The calling system order number Example General: 123456 | ||||
period | Σ | 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) | ||||
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||
replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
requisition | Σ | 0..1 | Identifier | Composite Request ID | ||||
status | ?!SΣ | 1..1 | code | Recommended value : active Binding: RequestStatus (required): The status of a service order. | ||||
intent | ?!SΣ | 1..1 | code | order Binding: RequestIntent (required): The kind of service request. Fixed Value: order | ||||
category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
priority | SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
code | SΣ | 0..1 | CodeableConcept | Allow specifing the kind of form that should be prefilled by MedNet, like laboratory order, radiologiy order, hospital admission Binding: MedNet Interface (MNI) - ServiceRequest Code ValueSet (extensible) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | SΣ | 0..* | Coding | Used to categorize the service request type. Could be used to filter the forms proposed by mednet to the user Slice: Unordered, Open by value:system, value:code | ||||
coding:snomed | SΣ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | 721965002 (Laboratory order) | 721964003 (Radiologiy order) | 721964003 (Hospital admission) | ||||
display | SΣ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
orderDetail:requestCodes | SΣI | 0..* | CodeableConcept | Allow specifing element codes like laboratory analyse codes that should be preselected in the form Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | Allow specifing element codes like laboratory analyse codes that should be preselected in the form | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 0..1 | uri | Identity of the terminology system Fixed Value: https://mednet.swiss/fhir/serviceRequest/orderDetail | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | The element code that should be preselected | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
quantity[x] | Σ | 0..1 | Service amount | |||||
quantityQuantity | Quantity | |||||||
quantityRatio | Ratio | |||||||
quantityRange | Range | |||||||
subject | SΣ | 1..1 | Reference(MedNet Interface (MNI) - Patient) | Link to the Patient | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
occurrence[x] | Σ | 0..1 | When service should occur | |||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
asNeeded[x] | Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
asNeededBoolean | boolean | |||||||
asNeededCodeableConcept | CodeableConcept | |||||||
authoredOn | Σ | 0..1 | dateTime | Date request signed | ||||
requester | SΣ | 0..1 | Reference(MedNet Interface (MNI) - PractitionerRole) | The MedNet practitioner that request to fill a document. MedNet will link the GLN of the practitionner with its own account id. MedNet will pre-select the account used to fill the document | ||||
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
performer | SΣ | 0..* | Reference(MedNet Interface (MNI) - PractitionerRole) | The MedNet institution, for which the document should be filled. This can be used to filter the forms proposed by mednet to the user. MedNet will only show the ones of this institution. MedNet will link the GLN of the institution with its own account ids. Multiple performer can be specified | ||||
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
locationReference | Σ | 0..* | Reference(Location) | Requested location | ||||
reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
supportingInfo | 0..* | Reference(Resource) | Additional clinical information | |||||
specimen | Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
note | 0..* | Annotation | Comments | |||||
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
ServiceRequest.language | preferred | CommonLanguages Max Binding: AllLanguages |
ServiceRequest.identifier:orderNr.use | required | IdentifierUse |
ServiceRequest.identifier:orderNr.type | extensible | Identifier Type Codes |
ServiceRequest.status | required | RequestStatus |
ServiceRequest.intent | required | Fixed Value: order |
ServiceRequest.category | example | ServiceRequestCategoryCodes |
ServiceRequest.priority | required | RequestPriority |
ServiceRequest.code | extensible | MNIServiceRequestCode |
ServiceRequest.orderDetail:requestCodes | example | ServiceRequestOrderDetailsCodes |
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes |
ServiceRequest.performerType | example | ParticipantRoles |
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType |
ServiceRequest.reasonCode | example | ProcedureReasonCodes |
ServiceRequest.bodySite | example | SNOMEDCTBodyStructures |
Id | Grade | Path | Details | Requirements |
dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Best Practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() | |
ele-1 | error | ServiceRequest.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | ServiceRequest.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | ServiceRequest.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | ServiceRequest.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | ServiceRequest.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.identifier:orderNr | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.identifier:orderNr.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | ServiceRequest.identifier:orderNr.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | ServiceRequest.identifier:orderNr.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.identifier:orderNr.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.identifier:orderNr.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.identifier:orderNr.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.identifier:orderNr.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.identifier:orderNr.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.instantiatesCanonical | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.instantiatesUri | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.replaces | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.requisition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.intent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.priority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.doNotPerform | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.code.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | ServiceRequest.code.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | ServiceRequest.code.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.code.coding:snomed | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.code.coding:snomed.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | ServiceRequest.code.coding:snomed.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | ServiceRequest.code.coding:snomed.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.code.coding:snomed.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.code.coding:snomed.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.code.coding:snomed.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.code.coding:snomed.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.code.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.orderDetail:requestCodes | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.orderDetail:requestCodes.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | ServiceRequest.orderDetail:requestCodes.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | ServiceRequest.orderDetail:requestCodes.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.orderDetail:requestCodes.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | ServiceRequest.orderDetail:requestCodes.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | ServiceRequest.orderDetail:requestCodes.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.orderDetail:requestCodes.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.orderDetail:requestCodes.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.orderDetail:requestCodes.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.orderDetail:requestCodes.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.orderDetail:requestCodes.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.quantity[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.occurrence[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.asNeeded[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.authoredOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.requester | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.performerType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.performer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.locationCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.locationReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.insurance | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.supportingInfo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.specimen | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.bodySite | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.patientInstruction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | ServiceRequest.relevantHistory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |