Regulatory Workflows and Interactions - pharma, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/APIX---API-Exchange-for-Medicinal-Products/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: APIX Endpoint for FHIR Subscription Notifications

Usages:

• Examples for this Profile: Authority FHIR Subscription Notification Endpoint and Best Company FHIR Subscription Notification Endpoint

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Endpoint		0..*	Endpoint	The technical details of an endpoint that can be used for electronic services
Endpoint.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Endpoint.contained		0..*	Resource	Contained, inline Resources
Endpoint.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Endpoint.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	Identifies this endpoint across multiple systems
Endpoint.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint.
Endpoint.connectionType	S This element must be supported. Σ This element is included in summaries.	1..*	CodeableConcept	Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (example)
Endpoint.connectionType.coding	S This element must be supported. Σ This element is included in summaries.	1..*	Coding	Code defined by a terminology system
Endpoint.connectionType.coding.system	Σ This element is included in summaries.	0..1	uri	Identity of the terminology system Required Pattern: http://hl7.org/fhir/uv/apix/CodeSystem/apix-temp (extensions allowed)
Endpoint.connectionType.coding.code	Σ This element is included in summaries. C	0..1	code	Symbol in syntax defined by the system Required Pattern: hl7-fhir-subscription-notify (extensions allowed)
Endpoint.name	S This element must be supported. Σ This element is included in summaries.	1..1	string	A name that this endpoint can be identified by
Endpoint.address	Σ This element is included in summaries.	1..1	url	The technical base address for connecting to this endpoint
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Endpoint.status	Base	required	Endpoint Status	📍5.0.0	FHIR Std.
Endpoint.connectionType	Base	example	Endpoint Connection Type	📍5.0.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Endpoint	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Endpoint	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().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-4	error	Endpoint	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	Endpoint	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Endpoint	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from Endpoint

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Endpoint		0..*	Endpoint	The technical details of an endpoint that can be used for electronic services
Endpoint.identifier	S This element must be supported.	1..*	Identifier	Identifies this endpoint across multiple systems
Endpoint.connectionType	S This element must be supported.	1..*	CodeableConcept	Protocol/Profile/Standard to be used with this endpoint connection
Endpoint.connectionType.coding	S This element must be supported.	1..*	Coding	Code defined by a terminology system
Endpoint.connectionType.coding.system		0..1	uri	Identity of the terminology system Required Pattern: http://hl7.org/fhir/uv/apix/CodeSystem/apix-temp (extensions allowed)
Endpoint.connectionType.coding.code		0..1	code	Symbol in syntax defined by the system Required Pattern: hl7-fhir-subscription-notify (extensions allowed)
Endpoint.name	S This element must be supported.	1..1	string	A name that this endpoint can be identified by
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Endpoint		0..*	Endpoint	The technical details of an endpoint that can be used for electronic services
Endpoint.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Endpoint.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Endpoint.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Endpoint.language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
Endpoint.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Endpoint.contained		0..*	Resource	Contained, inline Resources
Endpoint.extension		0..*	Extension	Additional content defined by implementations
Endpoint.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Endpoint.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	Identifies this endpoint across multiple systems
Endpoint.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint.
Endpoint.connectionType	S This element must be supported. Σ This element is included in summaries.	1..*	CodeableConcept	Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (example)
Endpoint.connectionType.id		0..1	id	Unique id for inter-element referencing
Endpoint.connectionType.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Endpoint.connectionType.coding	S This element must be supported. Σ This element is included in summaries.	1..*	Coding	Code defined by a terminology system
Endpoint.connectionType.coding.id		0..1	id	Unique id for inter-element referencing
Endpoint.connectionType.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Endpoint.connectionType.coding.system	Σ This element is included in summaries.	0..1	uri	Identity of the terminology system Required Pattern: http://hl7.org/fhir/uv/apix/CodeSystem/apix-temp (extensions allowed)
Endpoint.connectionType.coding.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Endpoint.connectionType.coding.code	Σ This element is included in summaries. C	0..1	code	Symbol in syntax defined by the system Required Pattern: hl7-fhir-subscription-notify (extensions allowed)
Endpoint.connectionType.coding.display	Σ This element is included in summaries. C	0..1	string	Representation defined by the system
Endpoint.connectionType.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Endpoint.connectionType.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Endpoint.name	S This element must be supported. Σ This element is included in summaries.	1..1	string	A name that this endpoint can be identified by
Endpoint.description	Σ This element is included in summaries.	0..1	string	Additional details about the endpoint that could be displayed as further information to identify the description beyond its name
Endpoint.environmentType	Σ This element is included in summaries.	0..*	CodeableConcept	The type of environment(s) exposed at this endpoint Binding: EndpointEnvironment (extensible)
Endpoint.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that manages this endpoint (might not be the organization that exposes the endpoint)
Endpoint.contact		0..*	ContactPoint	Contact details for source (e.g. troubleshooting)
Endpoint.period	Σ This element is included in summaries.	0..1	Period	Interval the endpoint is expected to be operational
Endpoint.payload		0..*	BackboneElement	Set of payloads that are provided by this endpoint
Endpoint.payload.id		0..1	string	Unique id for inter-element referencing
Endpoint.payload.extension		0..*	Extension	Additional content defined by implementations
Endpoint.payload.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Endpoint.payload.type	Σ This element is included in summaries.	0..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example)
Endpoint.payload.mimeType	Σ This element is included in summaries.	0..*	code	Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Endpoint.address	Σ This element is included in summaries.	1..1	url	The technical base address for connecting to this endpoint
Endpoint.header		0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Endpoint.language	Base	required	All Languages	📍5.0.0	FHIR Std.
Endpoint.status	Base	required	Endpoint Status	📍5.0.0	FHIR Std.
Endpoint.connectionType	Base	example	Endpoint Connection Type	📍5.0.0	FHIR Std.
Endpoint.environmentType	Base	extensible	Endpoint Environment	📍5.0.0	FHIR Std.
Endpoint.payload.type	Base	example	Endpoint Payload Type	📍5.0.0	FHIR Std.
Endpoint.payload.mimeType	Base	required	Mime Types	📍5.0.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Endpoint	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Endpoint	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().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-4	error	Endpoint	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	Endpoint	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Endpoint	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from Endpoint

Summary

Mandatory: 3 elements
Must-Support: 4 elements

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Endpoint		0..*	Endpoint	The technical details of an endpoint that can be used for electronic services
Endpoint.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Endpoint.contained		0..*	Resource	Contained, inline Resources
Endpoint.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Endpoint.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	Identifies this endpoint across multiple systems
Endpoint.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint.
Endpoint.connectionType	S This element must be supported. Σ This element is included in summaries.	1..*	CodeableConcept	Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (example)
Endpoint.connectionType.coding	S This element must be supported. Σ This element is included in summaries.	1..*	Coding	Code defined by a terminology system
Endpoint.connectionType.coding.system	Σ This element is included in summaries.	0..1	uri	Identity of the terminology system Required Pattern: http://hl7.org/fhir/uv/apix/CodeSystem/apix-temp (extensions allowed)
Endpoint.connectionType.coding.code	Σ This element is included in summaries. C	0..1	code	Symbol in syntax defined by the system Required Pattern: hl7-fhir-subscription-notify (extensions allowed)
Endpoint.name	S This element must be supported. Σ This element is included in summaries.	1..1	string	A name that this endpoint can be identified by
Endpoint.address	Σ This element is included in summaries.	1..1	url	The technical base address for connecting to this endpoint
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Endpoint.status	Base	required	Endpoint Status	📍5.0.0	FHIR Std.
Endpoint.connectionType	Base	example	Endpoint Connection Type	📍5.0.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Endpoint	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Endpoint	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().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-4	error	Endpoint	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	Endpoint	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Endpoint	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Differential View

This structure is derived from Endpoint

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Endpoint		0..*	Endpoint	The technical details of an endpoint that can be used for electronic services
Endpoint.identifier	S This element must be supported.	1..*	Identifier	Identifies this endpoint across multiple systems
Endpoint.connectionType	S This element must be supported.	1..*	CodeableConcept	Protocol/Profile/Standard to be used with this endpoint connection
Endpoint.connectionType.coding	S This element must be supported.	1..*	Coding	Code defined by a terminology system
Endpoint.connectionType.coding.system		0..1	uri	Identity of the terminology system Required Pattern: http://hl7.org/fhir/uv/apix/CodeSystem/apix-temp (extensions allowed)
Endpoint.connectionType.coding.code		0..1	code	Symbol in syntax defined by the system Required Pattern: hl7-fhir-subscription-notify (extensions allowed)
Endpoint.name	S This element must be supported.	1..1	string	A name that this endpoint can be identified by
Documentation for this format

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Endpoint		0..*	Endpoint	The technical details of an endpoint that can be used for electronic services
Endpoint.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Endpoint.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Endpoint.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Endpoint.language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
Endpoint.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Endpoint.contained		0..*	Resource	Contained, inline Resources
Endpoint.extension		0..*	Extension	Additional content defined by implementations
Endpoint.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Endpoint.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	Identifies this endpoint across multiple systems
Endpoint.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint.
Endpoint.connectionType	S This element must be supported. Σ This element is included in summaries.	1..*	CodeableConcept	Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (example)
Endpoint.connectionType.id		0..1	id	Unique id for inter-element referencing
Endpoint.connectionType.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Endpoint.connectionType.coding	S This element must be supported. Σ This element is included in summaries.	1..*	Coding	Code defined by a terminology system
Endpoint.connectionType.coding.id		0..1	id	Unique id for inter-element referencing
Endpoint.connectionType.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Endpoint.connectionType.coding.system	Σ This element is included in summaries.	0..1	uri	Identity of the terminology system Required Pattern: http://hl7.org/fhir/uv/apix/CodeSystem/apix-temp (extensions allowed)
Endpoint.connectionType.coding.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Endpoint.connectionType.coding.code	Σ This element is included in summaries. C	0..1	code	Symbol in syntax defined by the system Required Pattern: hl7-fhir-subscription-notify (extensions allowed)
Endpoint.connectionType.coding.display	Σ This element is included in summaries. C	0..1	string	Representation defined by the system
Endpoint.connectionType.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Endpoint.connectionType.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Endpoint.name	S This element must be supported. Σ This element is included in summaries.	1..1	string	A name that this endpoint can be identified by
Endpoint.description	Σ This element is included in summaries.	0..1	string	Additional details about the endpoint that could be displayed as further information to identify the description beyond its name
Endpoint.environmentType	Σ This element is included in summaries.	0..*	CodeableConcept	The type of environment(s) exposed at this endpoint Binding: EndpointEnvironment (extensible)
Endpoint.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that manages this endpoint (might not be the organization that exposes the endpoint)
Endpoint.contact		0..*	ContactPoint	Contact details for source (e.g. troubleshooting)
Endpoint.period	Σ This element is included in summaries.	0..1	Period	Interval the endpoint is expected to be operational
Endpoint.payload		0..*	BackboneElement	Set of payloads that are provided by this endpoint
Endpoint.payload.id		0..1	string	Unique id for inter-element referencing
Endpoint.payload.extension		0..*	Extension	Additional content defined by implementations
Endpoint.payload.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Endpoint.payload.type	Σ This element is included in summaries.	0..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example)
Endpoint.payload.mimeType	Σ This element is included in summaries.	0..*	code	Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Endpoint.address	Σ This element is included in summaries.	1..1	url	The technical base address for connecting to this endpoint
Endpoint.header		0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Endpoint.language	Base	required	All Languages	📍5.0.0	FHIR Std.
Endpoint.status	Base	required	Endpoint Status	📍5.0.0	FHIR Std.
Endpoint.connectionType	Base	example	Endpoint Connection Type	📍5.0.0	FHIR Std.
Endpoint.environmentType	Base	extensible	Endpoint Environment	📍5.0.0	FHIR Std.
Endpoint.payload.type	Base	example	Endpoint Payload Type	📍5.0.0	FHIR Std.
Endpoint.payload.mimeType	Base	required	Mime Types	📍5.0.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Endpoint	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Endpoint	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().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-4	error	Endpoint	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	Endpoint	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Endpoint	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from Endpoint

Summary

Mandatory: 3 elements
Must-Support: 4 elements

Maturity: 1

Other representations of profile: CSV, Excel, Schematron