Example Transport/simpledelivery (JSON)

Note
• This is a business identifier, not a resource identifier (see discussion Narrative )
• Cardinality XML 0..*
• Type JSON
• Identifier TTL Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module. Summary Raw JSON true Comments Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this example scenario outside of FHIR, where it is not possible to use the logical URI. ( canonical form ExampleScenario.version Element Id ExampleScenario.version Definition The identifier that is used to identify this version of the example scenario when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the example scenario author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is + also no expectation that versions can be placed in a lexicographical sequence. Note This is a business versionId, not a resource version id (see discussion see JSON Format Specification ) Cardinality 0..1 Type string Summary true Comments There may be different example scenario instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the example scenario with the format [url]|[version].

{
  "resourceType": "Transport",
  "id": "simpledelivery",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: Transport</b><a name=\"simpledelivery\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource Transport &quot;simpledelivery&quot; </p></div><p><b>identifier</b>: <span title=\" \nbusiness identifier - in this case the same as the request id\n \">id: Transport1234</span></p><p><b>basedOn</b>: <a href=\"supplyrequest-example-simpleorder.html\">SupplyRequest/simpleorder</a></p><p><b>partOf</b>: <span>: Central Supply Restock</span></p><p><b>status</b>: completed</p><p><b>intent</b>: order</p><p><b>requestedLocation</b>: <a href=\"broken-link.html\">Transport/location-hospitalLab: Requested location for item at City Hospital Lab</a></p><p><b>currentLocation</b>: <a href=\"broken-link.html\">Transport/location-labA: Current location for item at Lab A</a></p></div>"
  },
  "identifier": [
    {
      "value": "Transport1234"
    }
  ],
  "basedOn": [
    {
      "reference": "SupplyRequest/simpleorder"
    }
  ],
  "partOf": [
    {
      "display": "Central Supply Restock"
    }
  ],
  "status": "completed",
  "intent": "order",
  "requestedLocation": {
    "reference": "Transport/location-hospitalLab",
    "display": "Requested location for item at City Hospital Lab"
  },
  "currentLocation": {
    "reference": "Transport/location-labA",
    "display": "Current location for item at Lab A"
  }
}

The name is not expected to be globally unique. The name should be a simple alphanumeric type name Usage note: every effort has been made to ensure that it is machine-processing friendly. Invariants Affect this element inv-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}') To Do & A name should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a name. ExampleScenario.status Element Id ExampleScenario.status Definition The status of this example scenario. Enables tracking the life-cycle of the content. Cardinality 1..1 Terminology Binding PublicationStatus ( Required ) Type code Is Modifier true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) Summary true Comments Allows filtering of example scenarios that are appropriate for use versus not. ExampleScenario.experimental Element Id ExampleScenario.experimental Definition A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Cardinality 0..1 Type boolean Requirements Enables experimental content to be developed following the same lifecycle that would be used for a production-level example scenario. Summary true Comments Allows filtering of example scenarios that examples are appropriate for use versus not. ExampleScenario.date Element Id ExampleScenario.date Definition The date (and optionally time) when the example scenario was published. The date must change when the business version changes correct and it must change if the status code changes. In addition, it should change when the substantive content of the example scenario changes. (e.g. the 'content logical definition'). Cardinality 0..1 Type dateTime Alternate Names Revision Date Summary true Comments Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the example scenario. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. ExampleScenario.publisher Element Id ExampleScenario.publisher Definition The name of the organization or individual that published the example scenario. Cardinality 0..1 Type string Requirements Helps establish the "authority/credibility" of the example scenario. May also allow for contact. Summary true Comments Usually an organization useful, but may be an individual. The publisher (or steward) of the example scenario is the organization or individual primarily responsible for the maintenance and upkeep of the example scenario. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the example scenario. This item SHOULD be populated unless the information is available from context. ExampleScenario.contact Element Id ExampleScenario.contact Definition Contact details to assist a user in finding and communicating with the publisher. Cardinality 0..* Type ContactDetail Summary true Comments May be a web site, an email address, a telephone number, etc. ExampleScenario.useContext Element Id ExampleScenario.useContext Definition The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate example scenario instances. Cardinality 0..* Type UsageContext Requirements Assist in searching for appropriate content. Summary true Comments When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. ExampleScenario.jurisdiction Element Id ExampleScenario.jurisdiction Definition A legal or geographic region in which the example scenario is intended to be used. Cardinality 0..* Terminology Binding Jurisdiction ( Extensible ) Type CodeableConcept Summary true Comments It may be possible for the example scenario to be used in jurisdictions other than those for which it was originally designed or intended. ExampleScenario.copyright Element Id ExampleScenario.copyright Definition A copyright statement relating to the example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario. Cardinality 0..1 Type markdown Requirements Consumers must be able to determine any legal restrictions on the use of the example scenario and/or its content. Alternate Names License; Restrictions Comments nullFrequently, the copyright differs between the value set and the codes that they are included. The copyright statement should clearly differentiate between these when required. ExampleScenario.purpose Element Id ExampleScenario.purpose Definition What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario. Cardinality 0..1 Type markdown Comments This element does not describe the usage of the example scenario. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this example scenario. ExampleScenario.actor Element Id ExampleScenario.actor Definition Actor participating in the resource. Cardinality 0..* ExampleScenario.actor.actorId Element Id ExampleScenario.actor.actorId Definition ID or acronym of actor. Cardinality 1..1 Type string Comments should this be called ID or acronym? ExampleScenario.actor.type Element Id ExampleScenario.actor.type Definition The type of actor - person or system. Cardinality 1..1 Terminology Binding ExampleScenarioActorType ( Required ) Type code ExampleScenario.actor.name Element Id ExampleScenario.actor.name Definition The name of the actor as shown in the page. Cardinality 0..1 Type string Comments Cardinality: is name and description 1..1? ExampleScenario.actor.description Element Id ExampleScenario.actor.description Definition The description of the actor. Cardinality 0..1 Type markdown Comments Cardinality: is name and description 1..1? ExampleScenario.instance Element Id ExampleScenario.instance Definition Each resource and each version that is present in the workflow. Cardinality 0..* ExampleScenario.instance.resourceId Element Id ExampleScenario.instance.resourceId Definition The id of the resource for referencing. Cardinality 1..1 Type string ExampleScenario.instance.resourceType Element Id ExampleScenario.instance.resourceType Definition The type of the resource. Cardinality 1..1 Terminology Binding ResourceType ( Required ) Type code ExampleScenario.instance.name Element Id ExampleScenario.instance.name Definition A short name for the resource instance. Cardinality 0..1 Type string To Do Should name and description be 1..1? ExampleScenario.instance.description Element Id ExampleScenario.instance.description Definition Human-friendly description of the resource instance. Cardinality 0..1 Type markdown To Do Should name and description be 1..1? ExampleScenario.instance.version Element Id ExampleScenario.instance.version Definition A specific version of the resource. Note This is a business versionId, not a resource version id (see discussion ) Cardinality 0..* ExampleScenario.instance.version.versionId Element Id ExampleScenario.instance.version.versionId Definition The identifier of a specific version of a resource. Cardinality 1..1 Type string ExampleScenario.instance.version.description Element Id ExampleScenario.instance.version.description Definition The description of the resource version. Cardinality 1..1 Type markdown ExampleScenario.instance.containedInstance Element Id ExampleScenario.instance.containedInstance Definition Resources contained in the instance (e.g. the observations contained in a bundle). Cardinality 0..* ExampleScenario.instance.containedInstance.resourceId Element Id ExampleScenario.instance.containedInstance.resourceId Definition Each resource contained in the instance. Cardinality 1..1 Type string ExampleScenario.instance.containedInstance.versionId Element Id ExampleScenario.instance.containedInstance.versionId Definition A specific version of a resource contained in the instance. Cardinality 0..1 Type string ExampleScenario.process Element Id ExampleScenario.process Definition Each major process - a group of operations. Cardinality 0..* ExampleScenario.process.title Element Id ExampleScenario.process.title Definition The diagram title of the group of operations. Cardinality 1..1 Type string Summary true ExampleScenario.process.description Element Id ExampleScenario.process.description Definition A longer description of the group of operations. Cardinality 0..1 Type markdown ExampleScenario.process.preConditions Element Id ExampleScenario.process.preConditions Definition Description of initial status before the process starts. Cardinality 0..1 Type markdown ExampleScenario.process.postConditions Element Id ExampleScenario.process.postConditions Definition Description of final status after the process ends. Cardinality 0..1 Type markdown ExampleScenario.process.step Element Id ExampleScenario.process.step Definition Each step of the process. Cardinality 0..* ExampleScenario.process.step.process Element Id ExampleScenario.process.step.process Definition Nested process. Cardinality 0..* Type See ExampleScenario.process ExampleScenario.process.step.pause Element Id ExampleScenario.process.step.pause Definition If there is a pause in the flow. Cardinality 0..1 Type boolean ExampleScenario.process.step.operation Element Id ExampleScenario.process.step.operation Definition Each interaction or action. Cardinality 0..1 ExampleScenario.process.step.operation.number Element Id ExampleScenario.process.step.operation.number Definition The sequential number of the interaction, e.g. 1.2.5. Cardinality 1..1 Type string ExampleScenario.process.step.operation.type Element Id ExampleScenario.process.step.operation.type Definition The type of operation - CRUD. Cardinality 0..1 Type string ExampleScenario.process.step.operation.name Element Id ExampleScenario.process.step.operation.name Definition The human-friendly name of the interaction. Cardinality 0..1 Type string ExampleScenario.process.step.operation.initiator Element Id ExampleScenario.process.step.operation.initiator Definition Who starts the transaction. Cardinality 0..1 Type string ExampleScenario.process.step.operation.receiver Element Id ExampleScenario.process.step.operation.receiver Definition Who receives the transaction. Cardinality 0..1 Type string ExampleScenario.process.step.operation.description Element Id ExampleScenario.process.step.operation.description Definition A comment to be inserted in the diagram. Cardinality 0..1 Type markdown ExampleScenario.process.step.operation.initiatorActive Element Id ExampleScenario.process.step.operation.initiatorActive Definition Whether the initiator is deactivated right after the transaction. Cardinality 0..1 Type boolean ExampleScenario.process.step.operation.receiverActive Element Id ExampleScenario.process.step.operation.receiverActive Definition Whether the receiver is deactivated right after the transaction. Cardinality 0..1 Type boolean ExampleScenario.process.step.operation.request Element Id ExampleScenario.process.step.operation.request Definition Each resource instance used by the initiator. Cardinality 0..1 Type See ExampleScenario.instance.containedInstance ExampleScenario.process.step.operation.response Element Id ExampleScenario.process.step.operation.response Definition Each resource instance used by the responder. Cardinality 0..1 Type See ExampleScenario.instance.containedInstance ExampleScenario.process.step.alternative Element Id ExampleScenario.process.step.alternative Definition Indicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical circumstances. Cardinality 0..* ExampleScenario.process.step.alternative.title Element Id ExampleScenario.process.step.alternative.title Definition The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked. Cardinality 1..1 Type string ExampleScenario.process.step.alternative.description Element Id ExampleScenario.process.step.alternative.description Definition A human-readable description normative part of the alternative explaining when the alternative should occur rather than the base step. Cardinality 0..1 Type markdown ExampleScenario.process.step.alternative.step Element Id ExampleScenario.process.step.alternative.step Definition What happens in each alternative option. Cardinality 0..* Type See ExampleScenario.process.step ExampleScenario.workflow Element Id ExampleScenario.workflow Definition Another nested workflow. specification.