2nd DSTU Draft For Comment
This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
Generated Questionnaire for MessageHeader
{
"resourceType": "Questionnaire",
"id": "qs1",
"contained": [
{
"resourceType": "ValueSet",
"id": "vs2",
"url": "urn:uuid:9c0bba6e-05cb-49fe-a75e-7ec29f4804d9",
"name": "Type options for MessageHeader.receiver",
"description": "Type options for MessageHeader.receiver",
"status": "active",
"expansion": {
"timestamp": "2015-02-23T09:21:24+11:00",
"contains": [
{
"system": "http://hl7.org/fhir/resource-types",
"code": "Practitioner",
"display": "Practitioner"
},
{
"system": "http://hl7.org/fhir/resource-types",
"code": "Organization",
"display": "Organization"
}
]
}
},
{
"resourceType": "ValueSet",
"id": "vs3",
"url": "urn:uuid:56d828e2-bce1-436c-959d-e8ba61d59a33",
"name": "Type options for MessageHeader.responsible",
"description": "Type options for MessageHeader.responsible",
"status": "active",
"expansion": {
"timestamp": "2015-02-23T09:21:24+11:00",
"contains": [
{
"system": "http://hl7.org/fhir/resource-types",
"code": "Practitioner",
"display": "Practitioner"
},
{
"system": "http://hl7.org/fhir/resource-types",
"code": "Organization",
"display": "Organization"
}
]
}
}
],
"identifier": [
{
"system": "urn:ietf:rfc:3986"
}
],
"status": "draft",
"date": "2015-02-23T09:07:27+11:00",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"group": {
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The header for a message exchange that is either requesting or responding to an action. The Reference(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle."
}
],
"linkId": "MessageHeader",
"title": "A resource that describes a message that is exchanged between systems",
"required": true,
"repeats": false,
"group": [
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "string"
}
],
"linkId": "MessageHeader.id",
"required": false,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.id.value",
"text": "Logical id of this artefact",
"type": "string",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."
}
],
"linkId": "MessageHeader.meta",
"text": "Metadata about the resource",
"required": false,
"repeats": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "uri"
}
],
"linkId": "MessageHeader.implicitRules",
"required": false,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.implicitRules.value",
"text": "A set of rules under which this content was created",
"type": "string",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource\n\nNot all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "code"
}
],
"linkId": "MessageHeader.language",
"required": false,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.language.value",
"text": "language",
"type": "choice",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
}
],
"linkId": "MessageHeader.text",
"text": "Text summary of the resource, for human interpretation",
"required": false,
"repeats": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again."
}
],
"linkId": "MessageHeader.contained",
"text": "Contained, inline Resources",
"required": false,
"repeats": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The identifier of this message. This SHALL be unique within the scope of this stream of messages."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "string"
}
],
"linkId": "MessageHeader.identifier",
"required": true,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.identifier.value",
"text": "Id of this message",
"type": "string",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The time that the message was sent."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "instant"
}
],
"linkId": "MessageHeader.timestamp",
"required": true,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.timestamp.value",
"text": "Time that the message was sent",
"type": "instant",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value \"http://hl7.org/fhir/message-type\"."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "Coding"
}
],
"linkId": "MessageHeader.event",
"required": true,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.event.value",
"text": "Code for the event this message represents",
"type": "open-choice",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Information about the message that this message is a response to. Only present if this message is a response."
}
],
"linkId": "MessageHeader.response",
"title": "If this is a reply to prior message",
"required": false,
"repeats": false,
"group": [
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "unique id for the element within a resource (for internal references)."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "string"
}
],
"linkId": "MessageHeader.response.id",
"required": false,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.response.id.value",
"text": "xml:id (or equivalent in JSON)",
"type": "string",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The id of the message that this message is a response to."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "string"
}
],
"linkId": "MessageHeader.response.identifier",
"required": true,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.response.identifier.value",
"text": "Id of original message",
"type": "string",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not. This is a generic response to the request message. Specific data for the response will be found in MessageHeader.data."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "code"
}
],
"linkId": "MessageHeader.response.code",
"required": true,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.response.code.value",
"text": "code",
"type": "choice",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Full details of any issues found in the message. This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "Reference"
}
],
"linkId": "MessageHeader.response.details",
"required": false,
"repeats": true,
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/OperationOutcome?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "MessageHeader.response.details.value",
"text": "Specific list of hints/warnings/errors",
"type": "reference",
"required": false,
"repeats": false
}
]
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The source application from which this message originated."
}
],
"linkId": "MessageHeader.source",
"title": "Message Source Application",
"required": true,
"repeats": false,
"group": [
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "unique id for the element within a resource (for internal references)."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "string"
}
],
"linkId": "MessageHeader.source.id",
"required": false,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.source.id.value",
"text": "xml:id (or equivalent in JSON)",
"type": "string",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Human-readable name for the source system."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "string"
}
],
"linkId": "MessageHeader.source.name",
"required": false,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.source.name.value",
"text": "Name of system",
"type": "string",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "May include configuration or other information useful in debugging."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "string"
}
],
"linkId": "MessageHeader.source.software",
"required": false,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.source.software.value",
"text": "Name of software running the system",
"type": "string",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Can convey versions of multiple systems in situations where a message passes through multiple hands."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "string"
}
],
"linkId": "MessageHeader.source.version",
"required": false,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.source.version.value",
"text": "Version of software running",
"type": "string",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "An e-mail, phone, website or other contact point to use to resolve issues with message communications."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "ContactPoint"
}
],
"linkId": "MessageHeader.source.contact",
"text": "Human contact for problems",
"required": false,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.source.contact.system",
"text": "type:",
"type": "choice",
"required": false,
"repeats": false
},
{
"linkId": "MessageHeader.source.contact.value",
"text": "value:",
"type": "string",
"required": false,
"repeats": false
},
{
"linkId": "MessageHeader.source.contact.use",
"text": "use:",
"type": "choice",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Identifies the routing target to send acknowledgements to. The id may be a non-resolvable URI for systems that do not use standard network-based addresses."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "uri"
}
],
"linkId": "MessageHeader.source.endpoint",
"required": true,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.source.endpoint.value",
"text": "Actual message source address or id",
"type": "string",
"required": false,
"repeats": false
}
]
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The destination application which the message is intended for."
}
],
"linkId": "MessageHeader.destination",
"title": "Message Destination Application(s)",
"text": "there SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.",
"required": false,
"repeats": true,
"group": [
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "unique id for the element within a resource (for internal references)."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "string"
}
],
"linkId": "MessageHeader.destination.id",
"required": false,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.destination.id.value",
"text": "xml:id (or equivalent in JSON)",
"type": "string",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Human-readable name for the target system."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "string"
}
],
"linkId": "MessageHeader.destination.name",
"required": false,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.destination.name.value",
"text": "Name of system",
"type": "string",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Identifies the target end system in situations where the initial message transmission is to an intermediary system."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "Reference"
}
],
"linkId": "MessageHeader.destination.target",
"required": false,
"repeats": true,
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/Device?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "MessageHeader.destination.target.value",
"text": "Particular delivery destination within the destination",
"type": "reference",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Indicates where the message should be routed to. The id may be a non-resolvable URI for systems that do not use standard network-based addresses."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "uri"
}
],
"linkId": "MessageHeader.destination.endpoint",
"required": true,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.destination.endpoint.value",
"text": "Actual destination address or id",
"type": "string",
"required": false,
"repeats": false
}
]
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The person or device that performed the data entry leading to this message. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions. Usually only for the request, but can be used in a response."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "Reference"
}
],
"linkId": "MessageHeader.enterer",
"required": false,
"repeats": true,
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/Practitioner?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "MessageHeader.enterer.value",
"text": "The source of the data entry",
"type": "reference",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The logical author of the message - the person or device that decided the described event should happen. Where there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions. Usually only for the request, but can be used in a response."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "Reference"
}
],
"linkId": "MessageHeader.author",
"required": false,
"repeats": true,
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/Practitioner?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "MessageHeader.author.value",
"text": "The source of the decision",
"type": "reference",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient."
}
],
"linkId": "MessageHeader.receiver",
"text": "Intended \"real-world\" recipient for the data",
"required": false,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.receiver._type",
"text": "type",
"type": "choice",
"required": false,
"repeats": false,
"options": {
"reference": "#vs2"
},
"group": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "Reference"
}
],
"linkId": "MessageHeader.receiver._Practitioner",
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/Practitioner?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "MessageHeader.receiver._Practitioner.value",
"text": "Practitioner",
"type": "reference",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "Reference"
}
],
"linkId": "MessageHeader.receiver._Organization",
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/Organization?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "MessageHeader.receiver._Organization.value",
"text": "Organization",
"type": "reference",
"required": false,
"repeats": false
}
]
}
]
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party. Usually only for the request, but can be used in a response."
}
],
"linkId": "MessageHeader.responsible",
"text": "Final responsibility for event",
"required": false,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.responsible._type",
"text": "type",
"type": "choice",
"required": false,
"repeats": false,
"options": {
"reference": "#vs3"
},
"group": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "Reference"
}
],
"linkId": "MessageHeader.responsible._Practitioner",
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/Practitioner?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "MessageHeader.responsible._Practitioner.value",
"text": "Practitioner",
"type": "reference",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "Reference"
}
],
"linkId": "MessageHeader.responsible._Organization",
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/Organization?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "MessageHeader.responsible._Organization.value",
"text": "Organization",
"type": "reference",
"required": false,
"repeats": false
}
]
}
]
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Coded indication of the cause for the event - indicates a reason for the occurance of the event that is a focus of this message."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "CodeableConcept"
}
],
"linkId": "MessageHeader.reason",
"text": "Cause of event",
"required": false,
"repeats": true,
"question": [
{
"linkId": "MessageHeader.reason.coding",
"text": "code:",
"type": "open-choice",
"required": false,
"repeats": false
},
{
"linkId": "MessageHeader.reason.text",
"text": "text:",
"type": "string",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The actual data of the message - a reference to the root/focus class of the event. The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "Reference"
}
],
"linkId": "MessageHeader.data",
"required": false,
"repeats": true,
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/_search?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "MessageHeader.data.value",
"text": "The actual content of the message",
"type": "reference",
"required": false,
"repeats": false
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR DSTU (v0.4.0-4167) generated on Mon, Feb 23, 2015 09:21+1100.
Links: What's a DSTU? |
Version History |
Compare to DSTU1 |
|
Propose a change