POCP Prescription Enrollment
0.1.0 - CI Build US

POCP Prescription Enrollment - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: Rx Enroll MessageHeader - Initiation

Official URL: http://pocp.dev/fhir/us/rx-enroll/StructureDefinition/rx-enroll-messageheader-initiation Version: 0.1.0
Active as of 2022-02-10 Computable Name: RxEnrollMessageHeaderInitiation

This profile constrains a MessageHeader resource for use in an Rx Enroll Initiation message bundle. A Parameters resource is the focus.

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from MessageHeader

Summary

Mandatory: 4 elements
Must-Support: 4 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... eventCoding S1..1CodingCode for the event this message represents or link to event definition
.... system S1..1uriIdentity of the terminology system
Fixed Value: http://pocp.dev/fhir/us/rx-enroll/CodeSystem/rx-enroll-event-type
.... code S1..1codeSymbol in syntax defined by the system
Fixed Value: enrollment-initiation
... focus:parameters S1..1Reference(Rx Enroll Parameters - Initiation) {b}The actual content of the message

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for event[x] Σ1..1CodingCode for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... event[x]:eventCoding SΣ1..1CodingCode for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://pocp.dev/fhir/us/rx-enroll/CodeSystem/rx-enroll-event-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: enrollment-initiation
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... destination Σ0..*BackboneElementMessage destination application(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint Σ1..1urlActual destination address or id
.... receiver Σ0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender Σ0..1Reference(Practitioner | PractitionerRole | Organization)Real world sender of the message
... enterer Σ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author Σ0..1Reference(Practitioner | PractitionerRole)The source of the decision
... source Σ1..1BackboneElementMessage source application
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... software Σ0..1stringName of software running the system
.... version Σ0..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint Σ1..1urlActual message source address or id
... responsible Σ0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... reason Σ0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ0..1BackboneElementIf this is a reply to prior message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ1..1idId of original message
.... code Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... focus:parameters SΣ1..1Reference(Rx Enroll Parameters - Initiation) {b}The actual content of the message
... definition Σ0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... event[x]:eventCoding Σ1..1CodingCode for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pocp.dev/fhir/us/rx-enroll/CodeSystem/rx-enroll-event-type
.... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: enrollment-initiation
... focus:parameters Σ1..1Reference(Rx Enroll Parameters - Initiation) {b}The actual content of the message

doco Documentation for this format

This structure is derived from MessageHeader

Summary

Mandatory: 4 elements
Must-Support: 4 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... eventCoding S1..1CodingCode for the event this message represents or link to event definition
.... system S1..1uriIdentity of the terminology system
Fixed Value: http://pocp.dev/fhir/us/rx-enroll/CodeSystem/rx-enroll-event-type
.... code S1..1codeSymbol in syntax defined by the system
Fixed Value: enrollment-initiation
... focus:parameters S1..1Reference(Rx Enroll Parameters - Initiation) {b}The actual content of the message

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for event[x] Σ1..1CodingCode for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... event[x]:eventCoding SΣ1..1CodingCode for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://pocp.dev/fhir/us/rx-enroll/CodeSystem/rx-enroll-event-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: enrollment-initiation
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... destination Σ0..*BackboneElementMessage destination application(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint Σ1..1urlActual destination address or id
.... receiver Σ0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender Σ0..1Reference(Practitioner | PractitionerRole | Organization)Real world sender of the message
... enterer Σ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author Σ0..1Reference(Practitioner | PractitionerRole)The source of the decision
... source Σ1..1BackboneElementMessage source application
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... software Σ0..1stringName of software running the system
.... version Σ0..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint Σ1..1urlActual message source address or id
... responsible Σ0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... reason Σ0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ0..1BackboneElementIf this is a reply to prior message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ1..1idId of original message
.... code Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... focus:parameters SΣ1..1Reference(Rx Enroll Parameters - Initiation) {b}The actual content of the message
... definition Σ0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
MessageHeader.languagepreferredCommonLanguages
Max Binding: AllLanguages
MessageHeader.event[x]exampleMessageEvent
MessageHeader.event[x]:eventCodingexampleFixed Value: enrollment-initiation
MessageHeader.reasonexampleExampleMessageReasonCodes
MessageHeader.response.coderequiredResponseType

Constraints

IdGradePathDetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf 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-4errorMessageHeaderIf 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-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1errorMessageHeader.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.event[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.event[x]:eventCodingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.event[x]:eventCoding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.event[x]:eventCoding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.event[x]:eventCoding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.event[x]:eventCoding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.event[x]:eventCoding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.event[x]:eventCoding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.event[x]:eventCoding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.destinationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.destination.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.destination.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.destination.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.destination.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.destination.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.destination.targetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.destination.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.destination.receiverAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.senderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.entererAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.sourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.source.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.source.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.source.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.source.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.source.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.source.softwareAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.source.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.source.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.source.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.responsibleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.reasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.responseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.response.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.response.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.response.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.response.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.response.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.response.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.response.detailsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.focus:parametersAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.definitionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())