SPL Mapping FHIR R5 Implementation Guide
0.2.1 - Build CI United States of America flag

SPL Mapping FHIR R5 Implementation Guide, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-spl/ and changes regularly. See the Directory of published versions

Resource Profile: GDUFAFacilityInactivationMessage

Official URL: http://hl7.org/fhir/us/spl/StructureDefinition/GDUFAFacilityInactivationMessage Version: 0.2.1
Standards status: Trial-use Maturity Level: 1 Computable Name: GDUFAFacilityInactivationMessage

A profile of an GDUFA Facility Inactivation message

Usage:

Formal Views of Profile Content

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

This structure is derived from OrganizationMessage

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader OrganizationMessage
... event[x] 1..1 Coding Event code or link to EventDefinition
Required Pattern: At least the following
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/spl/CodeSystem/codesystem-fhirMessageTypes
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 02
... source
.... Slices for endpoint[x] 0..1 url, Reference(Endpoint) Actual source address or Endpoint resource
Slice: Unordered, Open by type:$this
..... endpoint[x]:endpointUrl 0..1 url Actual source address or Endpoint resource
Required Pattern: http://example.org/
... Slices for focus 2..* Reference(Organization) The actual content of the message
Slice: Unordered, Open by profile:$this.resolve()
.... focus:Registrant S 1..1 Reference(IdentifiedGDUFARegistrant) The actual content of the message
.... focus:GDUFAFacility S 1..* Reference(IdentifiedGDUFAFacility) The actual content of the message

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* OrganizationMessage A resource that describes a message that is exchanged between systems
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/spl/CodeSystem/codesystem-fhirMessageTypes
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 02
.... display SΣC 1..1 string Representation defined by the system
... source Σ 1..1 BackboneElement Message source application
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for endpoint[x] Σ 0..1 Actual source address or Endpoint resource
Slice: Unordered, Open by type:$this
..... endpointUrl url
..... endpointReference Reference(Endpoint)
..... endpoint[x]:endpointUrl Σ 0..1 url Actual source address or Endpoint resource
Required Pattern: http://example.org/
... Slices for focus SΣ 2..* Reference(Organization) The actual content of the message
Slice: Unordered, Open by profile:$this.resolve()
.... focus:Registrant SΣ 1..1 Reference(IdentifiedGDUFARegistrant) The actual content of the message
.... focus:GDUFAFacility SΣ 1..* Reference(IdentifiedGDUFAFacility) The actual content of the message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.event[x]requiredPattern: 02
http://hl7.org/fhir/us/spl/ValueSet/valueset-organizationSubmissionMessageTypes
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* OrganizationMessage A resource that describes a message that is exchanged between systems
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... event[x] SΣ 1..1 Coding Event code or link to EventDefinition
Binding: Organzation Submission Message Types (required)
Required Pattern: At least the following
.... 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://hl7.org/fhir/us/spl/CodeSystem/codesystem-fhirMessageTypes
.... version 0..1 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 02
.... display 0..1 string Representation defined by the system
.... userSelected 0..1 boolean If this coding was chosen directly by the user
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code ΣC 0..1 code Symbol in syntax defined by the system
.... display SΣC 1..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... destination Σ 0..* BackboneElement Message destination application(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint[x] Σ 0..1 Actual destination address or Endpoint resource
..... endpointUrl url
..... endpointReference Reference(Endpoint)
.... name Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender Σ 0..1 Reference(Practitioner | PractitionerRole | Device | Organization) Real world sender of the message
... author Σ 0..1 Reference(Practitioner | PractitionerRole | Device | Organization) The source of the decision
... source Σ 1..1 BackboneElement Message source application
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for endpoint[x] Σ 0..1 Actual source address or Endpoint resource
Slice: Unordered, Open by type:$this
..... endpointUrl url
..... endpointReference Reference(Endpoint)
..... endpoint[x]:endpointUrl Σ 0..1 url Actual source address or Endpoint resource
Required Pattern: http://example.org/
.... name Σ 0..1 string Name of system
.... software Σ 0..1 string Name of software running the system
.... version Σ 0..1 string Version of software running
.... contact Σ 0..1 ContactPoint Human contact for problems
... responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
... reason Σ 0..1 CodeableConcept Cause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ 0..1 BackboneElement If this is a reply to prior message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 1..1 Identifier Bundle.identifier of original message
.... code Σ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... Slices for focus SΣ 2..* Reference(Organization) The actual content of the message
Slice: Unordered, Open by profile:$this.resolve()
.... focus:Registrant SΣ 1..1 Reference(IdentifiedGDUFARegistrant) The actual content of the message
.... focus:GDUFAFacility SΣ 1..* Reference(IdentifiedGDUFAFacility) The actual content of the message
... definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
MessageHeader.event[x]requiredPattern: 02
http://hl7.org/fhir/us/spl/ValueSet/valueset-organizationSubmissionMessageTypes
from this IG
MessageHeader.reasonexampleExampleMessageReasonCodes
http://hl7.org/fhir/ValueSet/message-reason-encounter
from the FHIR Standard
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from OrganizationMessage

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MessageHeader.source.endpoint[x]
  • The element 1 is sliced based on the value of MessageHeader.focus

Maturity: 1

Differential View

This structure is derived from OrganizationMessage

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader OrganizationMessage
... event[x] 1..1 Coding Event code or link to EventDefinition
Required Pattern: At least the following
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/spl/CodeSystem/codesystem-fhirMessageTypes
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 02
... source
.... Slices for endpoint[x] 0..1 url, Reference(Endpoint) Actual source address or Endpoint resource
Slice: Unordered, Open by type:$this
..... endpoint[x]:endpointUrl 0..1 url Actual source address or Endpoint resource
Required Pattern: http://example.org/
... Slices for focus 2..* Reference(Organization) The actual content of the message
Slice: Unordered, Open by profile:$this.resolve()
.... focus:Registrant S 1..1 Reference(IdentifiedGDUFARegistrant) The actual content of the message
.... focus:GDUFAFacility S 1..* Reference(IdentifiedGDUFAFacility) The actual content of the message

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* OrganizationMessage A resource that describes a message that is exchanged between systems
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/spl/CodeSystem/codesystem-fhirMessageTypes
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 02
.... display SΣC 1..1 string Representation defined by the system
... source Σ 1..1 BackboneElement Message source application
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for endpoint[x] Σ 0..1 Actual source address or Endpoint resource
Slice: Unordered, Open by type:$this
..... endpointUrl url
..... endpointReference Reference(Endpoint)
..... endpoint[x]:endpointUrl Σ 0..1 url Actual source address or Endpoint resource
Required Pattern: http://example.org/
... Slices for focus SΣ 2..* Reference(Organization) The actual content of the message
Slice: Unordered, Open by profile:$this.resolve()
.... focus:Registrant SΣ 1..1 Reference(IdentifiedGDUFARegistrant) The actual content of the message
.... focus:GDUFAFacility SΣ 1..* Reference(IdentifiedGDUFAFacility) The actual content of the message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.event[x]requiredPattern: 02
http://hl7.org/fhir/us/spl/ValueSet/valueset-organizationSubmissionMessageTypes
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* OrganizationMessage A resource that describes a message that is exchanged between systems
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... event[x] SΣ 1..1 Coding Event code or link to EventDefinition
Binding: Organzation Submission Message Types (required)
Required Pattern: At least the following
.... 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://hl7.org/fhir/us/spl/CodeSystem/codesystem-fhirMessageTypes
.... version 0..1 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 02
.... display 0..1 string Representation defined by the system
.... userSelected 0..1 boolean If this coding was chosen directly by the user
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code ΣC 0..1 code Symbol in syntax defined by the system
.... display SΣC 1..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... destination Σ 0..* BackboneElement Message destination application(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint[x] Σ 0..1 Actual destination address or Endpoint resource
..... endpointUrl url
..... endpointReference Reference(Endpoint)
.... name Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender Σ 0..1 Reference(Practitioner | PractitionerRole | Device | Organization) Real world sender of the message
... author Σ 0..1 Reference(Practitioner | PractitionerRole | Device | Organization) The source of the decision
... source Σ 1..1 BackboneElement Message source application
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for endpoint[x] Σ 0..1 Actual source address or Endpoint resource
Slice: Unordered, Open by type:$this
..... endpointUrl url
..... endpointReference Reference(Endpoint)
..... endpoint[x]:endpointUrl Σ 0..1 url Actual source address or Endpoint resource
Required Pattern: http://example.org/
.... name Σ 0..1 string Name of system
.... software Σ 0..1 string Name of software running the system
.... version Σ 0..1 string Version of software running
.... contact Σ 0..1 ContactPoint Human contact for problems
... responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
... reason Σ 0..1 CodeableConcept Cause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ 0..1 BackboneElement If this is a reply to prior message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 1..1 Identifier Bundle.identifier of original message
.... code Σ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... Slices for focus SΣ 2..* Reference(Organization) The actual content of the message
Slice: Unordered, Open by profile:$this.resolve()
.... focus:Registrant SΣ 1..1 Reference(IdentifiedGDUFARegistrant) The actual content of the message
.... focus:GDUFAFacility SΣ 1..* Reference(IdentifiedGDUFAFacility) The actual content of the message
... definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
MessageHeader.event[x]requiredPattern: 02
http://hl7.org/fhir/us/spl/ValueSet/valueset-organizationSubmissionMessageTypes
from this IG
MessageHeader.reasonexampleExampleMessageReasonCodes
http://hl7.org/fhir/ValueSet/message-reason-encounter
from the FHIR Standard
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from OrganizationMessage

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MessageHeader.source.endpoint[x]
  • The element 1 is sliced based on the value of MessageHeader.focus

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron