{
"description": "Endpoint for secure message delivery",
"_filename": "StructureDefinition-au-pd-sm-endpoint.json",
"package_name": "hl7.fhir.au.pd",
"date": "2017-05-12T16:13:53+10:00",
"derivation": "constraint",
"meta": {
"lastUpdated": "2017-09-06T23:02:55.485+10:00"
},
"publisher": null,
"fhirVersion": "3.0.1",
"name": "Australian Secure Message Endpoint Directory Entry",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
} ],
"abstract": false,
"type": "Endpoint",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Australian Secure Message Endpoint Directory Entry",
"package_version": "0.2.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "Endpoint",
"min": 0,
"definition": "Enpoint defined for use in secure message addressing.",
"short": "Australian Secure Message Directory Endpoint Record",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "n/a",
"identity": "rim"
}, {
"map": "infrastructure.exchange",
"identity": "w5"
} ],
"max": "*",
"id": "Endpoint",
"base": {
"max": "*",
"min": 0,
"path": "Endpoint"
}
}, {
"path": "Endpoint.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Endpoint.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Endpoint.meta",
"min": 0,
"definition": "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.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Endpoint.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Endpoint.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Endpoint.implicitRules",
"comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "Endpoint.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Endpoint.language",
"comment": "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 Not 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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "Endpoint.text",
"min": 0,
"definition": "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.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Endpoint.text",
"condition": [ "dom-1" ],
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "Endpoint.contained",
"min": 0,
"definition": "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.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Endpoint.contained",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "Endpoint.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Endpoint.extension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Endpoint.extension",
"min": 0,
"definition": "Details of the HL7 V2 receiving facility.",
"short": "Receiving Facility Details",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility"
} ],
"sliceName": "receivingFacility",
"max": "1",
"id": "Endpoint.extension:receivingfacility",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Endpoint.extension",
"min": 0,
"definition": "Details of the HL7 V2 receiving application.",
"short": "Receiving Application Details",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication"
} ],
"sliceName": "receivingApplication",
"max": "1",
"id": "Endpoint.extension:receivingapplication",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Endpoint.extension",
"min": 0,
"definition": "Encrypting certificate reference or value for use on this endpoint with specified payloadType and payloadMimeType.",
"short": "Encrypting certificate details",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org.au/fhir/StructureDefinition/encrypting-qualified-certificate-reference"
} ],
"mustSupport": true,
"sliceName": "dataEnciphermentCertificate",
"max": "*",
"id": "Endpoint.extension:dataenciphermentcertificate",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Endpoint.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Endpoint.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "Endpoint.identifier",
"min": 0,
"definition": "Identifier for the organization that is used to identify the endpoint across multiple disparate systems.",
"short": "Identifies this endpoint across multiple systems",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "Endpoint.identifier",
"base": {
"max": "*",
"min": 0,
"path": "Endpoint.identifier"
},
"isSummary": true
}, {
"path": "Endpoint.status",
"min": 1,
"definition": "Secure messaging endpoint activation status.",
"isModifier": true,
"short": "active | suspended | error | off | entered-in-error | test",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EndpointStatus"
} ],
"description": "The status of the endpoint",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/endpoint-status"
}
},
"max": "1",
"id": "Endpoint.status",
"comment": "This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid.",
"base": {
"max": "1",
"min": 1,
"path": "Endpoint.status"
},
"isSummary": true
}, {
"path": "Endpoint.connectionType",
"min": 1,
"definition": "Protocol/Profile/Standard the endpoint supports.",
"short": "Service interface type",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "Coding"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSetUri": "http://hl7.org.au/fhir/ValueSet/valueset-au-serviceinterface"
},
"max": "1",
"id": "Endpoint.connectionType",
"comment": "For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.",
"base": {
"max": "1",
"min": 1,
"path": "Endpoint.connectionType"
},
"isSummary": true
}, {
"path": "Endpoint.name",
"min": 0,
"definition": "A friendly name that this endpoint can be referred to with.",
"short": "A name that this endpoint can be identified by",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Endpoint.name",
"base": {
"max": "1",
"min": 0,
"path": "Endpoint.name"
},
"isSummary": true
}, {
"path": "Endpoint.managingOrganization",
"min": 1,
"definition": "Details of the organisation that is managing the supply of this directory entry.",
"short": "Directory entry managing organisation.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"mustSupport": true,
"max": "1",
"id": "Endpoint.managingOrganization",
"comment": "This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an aplicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy.",
"base": {
"max": "1",
"min": 0,
"path": "Endpoint.managingOrganization"
},
"isSummary": true
}, {
"path": "Endpoint.managingOrganization.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Endpoint.managingOrganization.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Endpoint.managingOrganization.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Endpoint.managingOrganization.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Endpoint.managingOrganization.reference",
"min": 0,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Endpoint.managingOrganization.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "Endpoint.managingOrganization.identifier",
"min": 0,
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "Endpoint.managingOrganization.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "Endpoint.managingOrganization.display",
"min": 1,
"definition": "Details to display for the directory entry managing organisation, typically the name.",
"short": "Directroy entry managing organisation display details",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Endpoint.managingOrganization.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"path": "Endpoint.contact",
"min": 0,
"definition": "Details to contact operator of the endpoint responsible for it's support and maintenance.",
"short": "Endpoint operator contact",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"mustSupport": true,
"max": "*",
"id": "Endpoint.contact",
"base": {
"max": "*",
"min": 0,
"path": "Endpoint.contact"
}
}, {
"path": "Endpoint.period",
"min": 0,
"definition": "The interval during which the endpoint is expected to be operational.",
"short": "Interval the endpoint is expected to be operational",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "when.done",
"identity": "w5"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Endpoint.period",
"base": {
"max": "1",
"min": 0,
"path": "Endpoint.period"
},
"isSummary": true
}, {
"path": "Endpoint.payloadType",
"min": 1,
"definition": "Reference to identify the type of payload content (service category).",
"short": "Payload type ",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "preferred",
"valueSetUri": "http://hl7.org.au/fhir/ValueSet/valueset-au-endpoint-payload-type"
},
"max": "*",
"id": "Endpoint.payloadType",
"comment": "The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan.",
"base": {
"max": "*",
"min": 1,
"path": "Endpoint.payloadType"
},
"isSummary": true
}, {
"path": "Endpoint.payloadMimeType",
"min": 0,
"definition": "The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).",
"short": "Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
},
"max": "*",
"id": "Endpoint.payloadMimeType",
"comment": "Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.",
"base": {
"max": "*",
"min": 0,
"path": "Endpoint.payloadMimeType"
},
"isSummary": true
}, {
"path": "Endpoint.address",
"min": 1,
"definition": "Actual endpoint URL for communications",
"short": "URL address of the endpoint ",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": true,
"max": "1",
"id": "Endpoint.address",
"comment": "For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since their may be more than one, clients should avoid using relative URIs)\n\nThis address will be to the service base, without any parameters, or sub-services or resources tacked on.\n\nE.g. for a WADO-RS endpoint, the url should be \"https://pacs.hospital.org/wado-rs\"\n\nand not \"https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...\".",
"base": {
"max": "1",
"min": 1,
"path": "Endpoint.address"
},
"isSummary": true
}, {
"path": "Endpoint.header",
"min": 0,
"definition": "Additional headers / information to send as part of the notification.",
"short": "Usage depends on the channel type",
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Endpoint.header",
"comment": "Exactly what these mean depend on the channel type. The can convey additional information to the recipient and/or meet security requirements.",
"base": {
"max": "*",
"min": 0,
"path": "Endpoint.header"
},
"isSummary": false
} ]
},
"status": "draft",
"id": "55aaadb7-2fa1-4339-9cba-20db577c9ebd",
"kind": "resource",
"url": "http://hl7.org.au/fhir/StructureDefinition/au-pd-sm-endpoint",
"version": null,
"differential": {
"element": [ {
"id": "Endpoint",
"path": "Endpoint",
"short": "Australian Secure Message Directory Endpoint Record",
"definition": "Enpoint defined for use in secure message addressing."
}, {
"id": "Endpoint.extension",
"path": "Endpoint.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Endpoint.extension:receivingfacility",
"max": "1",
"path": "Endpoint.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility"
} ],
"short": "Receiving Facility Details",
"sliceName": "receivingFacility",
"definition": "Details of the HL7 V2 receiving facility."
}, {
"id": "Endpoint.extension:receivingapplication",
"max": "1",
"path": "Endpoint.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication"
} ],
"short": "Receiving Application Details",
"sliceName": "receivingApplication",
"definition": "Details of the HL7 V2 receiving application."
}, {
"id": "Endpoint.extension:dataenciphermentcertificate",
"path": "Endpoint.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org.au/fhir/StructureDefinition/encrypting-qualified-certificate-reference"
} ],
"short": "Encrypting certificate details",
"sliceName": "dataEnciphermentCertificate",
"definition": "Encrypting certificate reference or value for use on this endpoint with specified payloadType and payloadMimeType.",
"mustSupport": true
}, {
"id": "Endpoint.status",
"path": "Endpoint.status",
"definition": "Secure messaging endpoint activation status.",
"mustSupport": true
}, {
"id": "Endpoint.connectionType",
"path": "Endpoint.connectionType",
"short": "Service interface type",
"binding": {
"strength": "required",
"valueSetUri": "http://hl7.org.au/fhir/ValueSet/valueset-au-serviceinterface"
},
"definition": "Protocol/Profile/Standard the endpoint supports.",
"mustSupport": true
}, {
"id": "Endpoint.name",
"path": "Endpoint.name",
"mustSupport": true
}, {
"id": "Endpoint.managingOrganization",
"min": 1,
"path": "Endpoint.managingOrganization",
"short": "Directory entry managing organisation.",
"definition": "Details of the organisation that is managing the supply of this directory entry.",
"mustSupport": true
}, {
"id": "Endpoint.managingOrganization.display",
"min": 1,
"path": "Endpoint.managingOrganization.display",
"short": "Directroy entry managing organisation display details",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"definition": "Details to display for the directory entry managing organisation, typically the name."
}, {
"id": "Endpoint.contact",
"path": "Endpoint.contact",
"short": "Endpoint operator contact",
"definition": "Details to contact operator of the endpoint responsible for it's support and maintenance.",
"mustSupport": true
}, {
"id": "Endpoint.payloadType",
"path": "Endpoint.payloadType",
"short": "Payload type ",
"binding": {
"strength": "preferred",
"valueSetUri": "http://hl7.org.au/fhir/ValueSet/valueset-au-endpoint-payload-type"
},
"definition": "Reference to identify the type of payload content (service category).",
"mustSupport": true
}, {
"id": "Endpoint.address",
"path": "Endpoint.address",
"short": "URL address of the endpoint ",
"definition": "Actual endpoint URL for communications",
"mustSupport": true
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Endpoint"
}