Nictiz STU3 Zib2017
1.3.4 - CI Build

Publish Box goes here

Resource Profile: Medication Overview response structure

Profile on the Bundle resource which represents the structure of the retrieve medication overview response transaction. The output of the ‘$medication-overiew’ operation SHALL conform to this profile.

The official URL for this profile is:

http://nictiz.nl/fhir/StructureDefinition/Bundle-MedicationOverview

Formal Views of Profile Content

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

This structure is derived from Bundle

Summary

Mandatory: 2 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Bundle.entry is sliced based on the value of type:resource

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*BundleContains a collection of resources
... type 1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: searchset
... total 0..1unsignedIntIf search, the total number of matches
... entry 2..*(Slice Definition)Entry in the bundle - will have a resource, or information
Slice: Unordered, Open by type:resource
.... entry:List 1..1BackboneElementMedicationOveriew
..... resource 1..1Medication OverviewInformation summarized from a list of other resources
...... subject 1..1Reference(nl-core-patient) {b}If all resources have the same subject
...... entry:AdministrationAgreement 0..*BackboneElementEntries in the list
....... item 1..1Reference(HCIM AdministrationAgreement) {b}Actual entry

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*BundleContains a collection of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier Σ0..1IdentifierPersistent identifier for the bundle
... type Σ1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required)
Fixed Value: searchset
... total ΣI0..1unsignedIntIf search, the total number of matches
... link ΣI0..*BackboneElementLinks related to this Bundle
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... entry ΣI2..*(Slice Definition)Entry in the bundle - will have a resource, or information
Slice: Unordered, Open by type:resource
.... entry:All Slices Content/Rules for all slices
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... link Σ0..*See linkLinks related to this entry
..... fullUrl Σ0..1uriAbsolute URL for resource (server address, or UUID/OID)
..... resource Σ0..1ResourceA resource in the bundle
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementTransaction Related Information
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... method Σ1..1codeGET | POST | PUT | DELETE
Binding: HTTPVerb (required)
...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing update contention
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣI0..1BackboneElementTransaction Related Information
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location, if the operation returns a location
...... etag Σ0..1stringThe etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:List ΣI1..1BackboneElementMedicationOveriew
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... link Σ0..*See linkLinks related to this entry
..... fullUrl Σ0..1uriAbsolute URL for resource (server address, or UUID/OID)
..... resource I1..1Medication OverviewInformation summarized from a list of other resources
...... id Σ0..1idLogical id of this artifact
...... meta Σ0..1MetaMetadata about the resource
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
...... text I0..1NarrativeText summary of the resource, for human interpretation
...... contained 0..*ResourceContained, inline Resources
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... MedicationOverview-Verification I1..1(Complex)Verification
URL: http://nictiz.nl/fhir/StructureDefinition/MedicationOverview-Verification
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... extension:VerificationPatient 1..1ExtensionExtension
........ id 0..1stringxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
......... id 0..1stringxml:id (or equivalent in JSON)
......... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
......... url 1..1uriidentifies the meaning of the extension
......... value[x] 0..1Value of extension
.......... valueBase64Binarybase64Binary
.......... valueBooleanboolean
.......... valueCodecode
.......... valueDatedate
.......... valueDateTimedateTime
.......... valueDecimaldecimal
.......... valueIdid
.......... valueInstantinstant
.......... valueIntegerinteger
.......... valueMarkdownmarkdown
.......... valueOidoid
.......... valuePositiveIntpositiveInt
.......... valueStringstring
.......... valueTimetime
.......... valueUnsignedIntunsignedInt
.......... valueUriuri
.......... valueAddressAddress
.......... valueAgeAge
.......... valueAnnotationAnnotation
.......... valueAttachmentAttachment
.......... valueCodeableConceptCodeableConcept
.......... valueCodingCoding
.......... valueContactPointContactPoint
.......... valueCountCount
.......... valueDistanceDistance
.......... valueDurationDuration
.......... valueHumanNameHumanName
.......... valueIdentifierIdentifier
.......... valueMoneyMoney
.......... valuePeriodPeriod
.......... valueQuantityQuantity
.......... valueRangeRange
.......... valueRatioRatio
.......... valueReferenceReference(Any)
.......... valueSampledDataSampledData
.......... valueSignatureSignature
.......... valueTimingTiming
.......... valueMetaMeta
........ url 1..1uri"VerificationPatient"
........ value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueBoolean 0..1booleanValue of extension
....... extension:VerificationPatientDate 0..1ExtensionExtension
........ id 0..1stringxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
......... id 0..1stringxml:id (or equivalent in JSON)
......... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
......... url 1..1uriidentifies the meaning of the extension
......... value[x] 0..1Value of extension
.......... valueBase64Binarybase64Binary
.......... valueBooleanboolean
.......... valueCodecode
.......... valueDatedate
.......... valueDateTimedateTime
.......... valueDecimaldecimal
.......... valueIdid
.......... valueInstantinstant
.......... valueIntegerinteger
.......... valueMarkdownmarkdown
.......... valueOidoid
.......... valuePositiveIntpositiveInt
.......... valueStringstring
.......... valueTimetime
.......... valueUnsignedIntunsignedInt
.......... valueUriuri
.......... valueAddressAddress
.......... valueAgeAge
.......... valueAnnotationAnnotation
.......... valueAttachmentAttachment
.......... valueCodeableConceptCodeableConcept
.......... valueCodingCoding
.......... valueContactPointContactPoint
.......... valueCountCount
.......... valueDistanceDistance
.......... valueDurationDuration
.......... valueHumanNameHumanName
.......... valueIdentifierIdentifier
.......... valueMoneyMoney
.......... valuePeriodPeriod
.......... valueQuantityQuantity
.......... valueRangeRange
.......... valueRatioRatio
.......... valueReferenceReference(Any)
.......... valueSampledDataSampledData
.......... valueSignatureSignature
.......... valueTimingTiming
.......... valueMetaMeta
........ url 1..1uri"VerificationPatientDate"
........ value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueDateTime 0..1dateTimeValue of extension
....... extension:VerificationHealthProfessional 1..1ExtensionExtension
........ id 0..1stringxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
......... id 0..1stringxml:id (or equivalent in JSON)
......... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
......... url 1..1uriidentifies the meaning of the extension
......... value[x] 0..1Value of extension
.......... valueBase64Binarybase64Binary
.......... valueBooleanboolean
.......... valueCodecode
.......... valueDatedate
.......... valueDateTimedateTime
.......... valueDecimaldecimal
.......... valueIdid
.......... valueInstantinstant
.......... valueIntegerinteger
.......... valueMarkdownmarkdown
.......... valueOidoid
.......... valuePositiveIntpositiveInt
.......... valueStringstring
.......... valueTimetime
.......... valueUnsignedIntunsignedInt
.......... valueUriuri
.......... valueAddressAddress
.......... valueAgeAge
.......... valueAnnotationAnnotation
.......... valueAttachmentAttachment
.......... valueCodeableConceptCodeableConcept
.......... valueCodingCoding
.......... valueContactPointContactPoint
.......... valueCountCount
.......... valueDistanceDistance
.......... valueDurationDuration
.......... valueHumanNameHumanName
.......... valueIdentifierIdentifier
.......... valueMoneyMoney
.......... valuePeriodPeriod
.......... valueQuantityQuantity
.......... valueRangeRange
.......... valueRatioRatio
.......... valueReferenceReference(Any)
.......... valueSampledDataSampledData
.......... valueSignatureSignature
.......... valueTimingTiming
.......... valueMetaMeta
........ url 1..1uri"VerificationHealthProfessional"
........ value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueBoolean 0..1booleanValue of extension
....... extension:VerificationHealthProfessionalDate 0..1ExtensionExtension
........ id 0..1stringxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
......... id 0..1stringxml:id (or equivalent in JSON)
......... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
......... url 1..1uriidentifies the meaning of the extension
......... value[x] 0..1Value of extension
.......... valueBase64Binarybase64Binary
.......... valueBooleanboolean
.......... valueCodecode
.......... valueDatedate
.......... valueDateTimedateTime
.......... valueDecimaldecimal
.......... valueIdid
.......... valueInstantinstant
.......... valueIntegerinteger
.......... valueMarkdownmarkdown
.......... valueOidoid
.......... valuePositiveIntpositiveInt
.......... valueStringstring
.......... valueTimetime
.......... valueUnsignedIntunsignedInt
.......... valueUriuri
.......... valueAddressAddress
.......... valueAgeAge
.......... valueAnnotationAnnotation
.......... valueAttachmentAttachment
.......... valueCodeableConceptCodeableConcept
.......... valueCodingCoding
.......... valueContactPointContactPoint
.......... valueCountCount
.......... valueDistanceDistance
.......... valueDurationDuration
.......... valueHumanNameHumanName
.......... valueIdentifierIdentifier
.......... valueMoneyMoney
.......... valuePeriodPeriod
.......... valueQuantityQuantity
.......... valueRangeRange
.......... valueRatioRatio
.......... valueReferenceReference(Any)
.......... valueSampledDataSampledData
.......... valueSignatureSignature
.......... valueTimingTiming
.......... valueMetaMeta
........ url 1..1uri"VerificationHealthProfessionalDate"
........ value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueDateTime 0..1dateTimeVerification Date
....... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/MedicationOverview-Verification"
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... identifier 0..*IdentifierBusiness identifier
...... status ?!Σ1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required)
...... mode ?!Σ1..1codeworking | snapshot | changes
Binding: ListMode (required)
...... title Σ0..1stringDescriptive name for the list
Example General: Dr. Jane's Patients
...... code Σ1..1CodeableConceptWhat the purpose of this list is
Binding: Example Use Codes for List (example)
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ1..1CodingCode defined by a terminology system
........ id 0..1stringxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 11181000146103
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
...... subject Σ1..1Reference(nl-core-patient) {b}If all resources have the same subject
...... encounter 0..1Reference(Encounter)Context in which list created
...... date Σ1..1dateTimeMedication Overview date
...... source Σ1..1Reference(Practitioner | nl-core-patient | Device)Who and/or what defined the list contents (aka Author)
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... MedicationOverview-SourceOrganization 1..*Reference()Extension
URL: http://nictiz.nl/fhir/StructureDefinition/MedicationOverview-SourceOrganization
........ id 0..1stringxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/MedicationOverview-SourceOrganization"
........ value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueReference 0..1Reference(nl-core-organization)Value of extension
....... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
...... orderedBy 0..1CodeableConceptWhat order the list has
Binding: List Order Codes (preferred)
...... note 0..*AnnotationComments about the list
...... entry I0..*(Slice Definition)Entries in the list
Slice: Unordered, Open by profile:item.reference.resolve()
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementTransaction Related Information
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... method Σ1..1codeGET | POST | PUT | DELETE
Binding: HTTPVerb (required)
...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing update contention
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣI0..1BackboneElementTransaction Related Information
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location, if the operation returns a location
...... etag Σ0..1stringThe etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

This structure is derived from Bundle

Summary

Mandatory: 2 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Bundle.entry is sliced based on the value of type:resource

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*BundleContains a collection of resources
... type 1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: searchset
... total 0..1unsignedIntIf search, the total number of matches
... entry 2..*(Slice Definition)Entry in the bundle - will have a resource, or information
Slice: Unordered, Open by type:resource
.... entry:List 1..1BackboneElementMedicationOveriew
..... resource 1..1Medication OverviewInformation summarized from a list of other resources
...... subject 1..1Reference(nl-core-patient) {b}If all resources have the same subject
...... entry:AdministrationAgreement 0..*BackboneElementEntries in the list
....... item 1..1Reference(HCIM AdministrationAgreement) {b}Actual entry

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*BundleContains a collection of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier Σ0..1IdentifierPersistent identifier for the bundle
... type Σ1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required)
Fixed Value: searchset
... total ΣI0..1unsignedIntIf search, the total number of matches
... link ΣI0..*BackboneElementLinks related to this Bundle
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... entry ΣI2..*(Slice Definition)Entry in the bundle - will have a resource, or information
Slice: Unordered, Open by type:resource
.... entry:All Slices Content/Rules for all slices
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... link Σ0..*See linkLinks related to this entry
..... fullUrl Σ0..1uriAbsolute URL for resource (server address, or UUID/OID)
..... resource Σ0..1ResourceA resource in the bundle
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementTransaction Related Information
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... method Σ1..1codeGET | POST | PUT | DELETE
Binding: HTTPVerb (required)
...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing update contention
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣI0..1BackboneElementTransaction Related Information
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location, if the operation returns a location
...... etag Σ0..1stringThe etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:List ΣI1..1BackboneElementMedicationOveriew
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... link Σ0..*See linkLinks related to this entry
..... fullUrl Σ0..1uriAbsolute URL for resource (server address, or UUID/OID)
..... resource I1..1Medication OverviewInformation summarized from a list of other resources
...... id Σ0..1idLogical id of this artifact
...... meta Σ0..1MetaMetadata about the resource
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
...... text I0..1NarrativeText summary of the resource, for human interpretation
...... contained 0..*ResourceContained, inline Resources
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... MedicationOverview-Verification I1..1(Complex)Verification
URL: http://nictiz.nl/fhir/StructureDefinition/MedicationOverview-Verification
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... extension:VerificationPatient 1..1ExtensionExtension
........ id 0..1stringxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
......... id 0..1stringxml:id (or equivalent in JSON)
......... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
......... url 1..1uriidentifies the meaning of the extension
......... value[x] 0..1Value of extension
.......... valueBase64Binarybase64Binary
.......... valueBooleanboolean
.......... valueCodecode
.......... valueDatedate
.......... valueDateTimedateTime
.......... valueDecimaldecimal
.......... valueIdid
.......... valueInstantinstant
.......... valueIntegerinteger
.......... valueMarkdownmarkdown
.......... valueOidoid
.......... valuePositiveIntpositiveInt
.......... valueStringstring
.......... valueTimetime
.......... valueUnsignedIntunsignedInt
.......... valueUriuri
.......... valueAddressAddress
.......... valueAgeAge
.......... valueAnnotationAnnotation
.......... valueAttachmentAttachment
.......... valueCodeableConceptCodeableConcept
.......... valueCodingCoding
.......... valueContactPointContactPoint
.......... valueCountCount
.......... valueDistanceDistance
.......... valueDurationDuration
.......... valueHumanNameHumanName
.......... valueIdentifierIdentifier
.......... valueMoneyMoney
.......... valuePeriodPeriod
.......... valueQuantityQuantity
.......... valueRangeRange
.......... valueRatioRatio
.......... valueReferenceReference(Any)
.......... valueSampledDataSampledData
.......... valueSignatureSignature
.......... valueTimingTiming
.......... valueMetaMeta
........ url 1..1uri"VerificationPatient"
........ value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueBoolean 0..1booleanValue of extension
....... extension:VerificationPatientDate 0..1ExtensionExtension
........ id 0..1stringxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
......... id 0..1stringxml:id (or equivalent in JSON)
......... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
......... url 1..1uriidentifies the meaning of the extension
......... value[x] 0..1Value of extension
.......... valueBase64Binarybase64Binary
.......... valueBooleanboolean
.......... valueCodecode
.......... valueDatedate
.......... valueDateTimedateTime
.......... valueDecimaldecimal
.......... valueIdid
.......... valueInstantinstant
.......... valueIntegerinteger
.......... valueMarkdownmarkdown
.......... valueOidoid
.......... valuePositiveIntpositiveInt
.......... valueStringstring
.......... valueTimetime
.......... valueUnsignedIntunsignedInt
.......... valueUriuri
.......... valueAddressAddress
.......... valueAgeAge
.......... valueAnnotationAnnotation
.......... valueAttachmentAttachment
.......... valueCodeableConceptCodeableConcept
.......... valueCodingCoding
.......... valueContactPointContactPoint
.......... valueCountCount
.......... valueDistanceDistance
.......... valueDurationDuration
.......... valueHumanNameHumanName
.......... valueIdentifierIdentifier
.......... valueMoneyMoney
.......... valuePeriodPeriod
.......... valueQuantityQuantity
.......... valueRangeRange
.......... valueRatioRatio
.......... valueReferenceReference(Any)
.......... valueSampledDataSampledData
.......... valueSignatureSignature
.......... valueTimingTiming
.......... valueMetaMeta
........ url 1..1uri"VerificationPatientDate"
........ value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueDateTime 0..1dateTimeValue of extension
....... extension:VerificationHealthProfessional 1..1ExtensionExtension
........ id 0..1stringxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
......... id 0..1stringxml:id (or equivalent in JSON)
......... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
......... url 1..1uriidentifies the meaning of the extension
......... value[x] 0..1Value of extension
.......... valueBase64Binarybase64Binary
.......... valueBooleanboolean
.......... valueCodecode
.......... valueDatedate
.......... valueDateTimedateTime
.......... valueDecimaldecimal
.......... valueIdid
.......... valueInstantinstant
.......... valueIntegerinteger
.......... valueMarkdownmarkdown
.......... valueOidoid
.......... valuePositiveIntpositiveInt
.......... valueStringstring
.......... valueTimetime
.......... valueUnsignedIntunsignedInt
.......... valueUriuri
.......... valueAddressAddress
.......... valueAgeAge
.......... valueAnnotationAnnotation
.......... valueAttachmentAttachment
.......... valueCodeableConceptCodeableConcept
.......... valueCodingCoding
.......... valueContactPointContactPoint
.......... valueCountCount
.......... valueDistanceDistance
.......... valueDurationDuration
.......... valueHumanNameHumanName
.......... valueIdentifierIdentifier
.......... valueMoneyMoney
.......... valuePeriodPeriod
.......... valueQuantityQuantity
.......... valueRangeRange
.......... valueRatioRatio
.......... valueReferenceReference(Any)
.......... valueSampledDataSampledData
.......... valueSignatureSignature
.......... valueTimingTiming
.......... valueMetaMeta
........ url 1..1uri"VerificationHealthProfessional"
........ value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueBoolean 0..1booleanValue of extension
....... extension:VerificationHealthProfessionalDate 0..1ExtensionExtension
........ id 0..1stringxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
......... id 0..1stringxml:id (or equivalent in JSON)
......... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
......... url 1..1uriidentifies the meaning of the extension
......... value[x] 0..1Value of extension
.......... valueBase64Binarybase64Binary
.......... valueBooleanboolean
.......... valueCodecode
.......... valueDatedate
.......... valueDateTimedateTime
.......... valueDecimaldecimal
.......... valueIdid
.......... valueInstantinstant
.......... valueIntegerinteger
.......... valueMarkdownmarkdown
.......... valueOidoid
.......... valuePositiveIntpositiveInt
.......... valueStringstring
.......... valueTimetime
.......... valueUnsignedIntunsignedInt
.......... valueUriuri
.......... valueAddressAddress
.......... valueAgeAge
.......... valueAnnotationAnnotation
.......... valueAttachmentAttachment
.......... valueCodeableConceptCodeableConcept
.......... valueCodingCoding
.......... valueContactPointContactPoint
.......... valueCountCount
.......... valueDistanceDistance
.......... valueDurationDuration
.......... valueHumanNameHumanName
.......... valueIdentifierIdentifier
.......... valueMoneyMoney
.......... valuePeriodPeriod
.......... valueQuantityQuantity
.......... valueRangeRange
.......... valueRatioRatio
.......... valueReferenceReference(Any)
.......... valueSampledDataSampledData
.......... valueSignatureSignature
.......... valueTimingTiming
.......... valueMetaMeta
........ url 1..1uri"VerificationHealthProfessionalDate"
........ value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueDateTime 0..1dateTimeVerification Date
....... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/MedicationOverview-Verification"
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... identifier 0..*IdentifierBusiness identifier
...... status ?!Σ1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required)
...... mode ?!Σ1..1codeworking | snapshot | changes
Binding: ListMode (required)
...... title Σ0..1stringDescriptive name for the list
Example General: Dr. Jane's Patients
...... code Σ1..1CodeableConceptWhat the purpose of this list is
Binding: Example Use Codes for List (example)
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ1..1CodingCode defined by a terminology system
........ id 0..1stringxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 11181000146103
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
...... subject Σ1..1Reference(nl-core-patient) {b}If all resources have the same subject
...... encounter 0..1Reference(Encounter)Context in which list created
...... date Σ1..1dateTimeMedication Overview date
...... source Σ1..1Reference(Practitioner | nl-core-patient | Device)Who and/or what defined the list contents (aka Author)
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... MedicationOverview-SourceOrganization 1..*Reference()Extension
URL: http://nictiz.nl/fhir/StructureDefinition/MedicationOverview-SourceOrganization
........ id 0..1stringxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/MedicationOverview-SourceOrganization"
........ value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueReference 0..1Reference(nl-core-organization)Value of extension
....... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
...... orderedBy 0..1CodeableConceptWhat order the list has
Binding: List Order Codes (preferred)
...... note 0..*AnnotationComments about the list
...... entry I0..*(Slice Definition)Entries in the list
Slice: Unordered, Open by profile:item.reference.resolve()
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementTransaction Related Information
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... method Σ1..1codeGET | POST | PUT | DELETE
Binding: HTTPVerb (required)
...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing update contention
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣI0..1BackboneElementTransaction Related Information
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location, if the operation returns a location
...... etag Σ0..1stringThe etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Bundle.languageextensibleCommon Languages
Max Binding: All Languages
Bundle.typerequiredFixed Value: searchset
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:List.resource.languageextensibleCommon Languages
Max Binding: All Languages
Bundle.entry:List.resource.statusrequiredListStatus
Bundle.entry:List.resource.moderequiredListMode
Bundle.entry:List.resource.codeexampleExample Use Codes for List
Bundle.entry:List.resource.orderedBypreferredList Order Codes
List.entry.flagexamplePatient Medicine Change Types
Bundle.entry:List.resource.entry:MedicationAgreement.flagexamplePatient Medicine Change Types
Bundle.entry:List.resource.entry:AdministrationAgreement.flagexamplePatient Medicine Change Types
Bundle.entry:List.resource.entry:MedicationUsage.flagexamplePatient Medicine Change Types
Bundle.entry:List.resource.emptyReasonpreferredList Empty Reasons
Bundle.entry:List.search.moderequiredSearchEntryMode
Bundle.entry:List.request.methodrequiredHTTPVerb

Constraints

IdPathDetailsRequirements
bdl-7BundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId
: entry.where(fullUrl).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-9BundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-3Bundleentry.request only for some types of bundles
: entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history'
bdl-4Bundleentry.response only for some types of bundles
: entry.response.empty() or type = 'batch-response' or type = 'transaction-response'
bdl-1Bundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2Bundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
ele-1Bundle.linkAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Bundle.entryAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
bdl-8Bundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-5Bundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
ele-1Bundle.entry.searchAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Bundle.entry.requestAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Bundle.entry.responseAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Bundle.entry:ListAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
bdl-8Bundle.entry:ListfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-5Bundle.entry:Listmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
dom-2Bundle.entry:List.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1Bundle.entry:List.resourceIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4Bundle.entry:List.resourceIf 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-3Bundle.entry:List.resourceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
lst-2Bundle.entry:List.resourceThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-1Bundle.entry:List.resourceA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
ele-1Bundle.entry:List.resource.extension:VerificationAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Bundle.entry:List.resource.extension:VerificationMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:List.resource.entryAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Bundle.entry:List.resource.entry:MedicationAgreementAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Bundle.entry:List.resource.entry:AdministrationAgreementAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Bundle.entry:List.resource.entry:MedicationUsageAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Bundle.entry:List.searchAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Bundle.entry:List.requestAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Bundle.entry:List.responseAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())